HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::Film Class Reference

A simple class that allows for concurrent writes to pixels in an image, background initialization of the image, and PPM or EXR file output. More...

#include <RayTracer.h>

Classes

struct  RGBA
 Floating-point RGBA components in the range [0, 1]. More...
 

Public Member Functions

 Film (size_t width, size_t height)
 
 Film (size_t width, size_t height, const RGBA &bg)
 
const RGBApixel (size_t w, size_t h) const
 
RGBApixel (size_t w, size_t h)
 
void fill (const RGBA &rgb=RGBA(0))
 
void checkerboard (const RGBA &c1=RGBA(0.3f), const RGBA &c2=RGBA(0.6f), size_t size=32)
 
void savePPM (const std::string &fileName)
 
size_t width () const
 
size_t height () const
 
size_t numPixels () const
 
const RGBApixels () const
 

Detailed Description

A simple class that allows for concurrent writes to pixels in an image, background initialization of the image, and PPM or EXR file output.

Definition at line 259 of file RayTracer.h.

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::tools::Film::Film ( size_t  width,
size_t  height 
)
inline

Definition at line 298 of file RayTracer.h.

openvdb::OPENVDB_VERSION_NAME::tools::Film::Film ( size_t  width,
size_t  height,
const RGBA bg 
)
inline

Definition at line 302 of file RayTracer.h.

Member Function Documentation

void openvdb::OPENVDB_VERSION_NAME::tools::Film::checkerboard ( const RGBA c1 = RGBA(0.3f),
const RGBA c2 = RGBA(0.6f),
size_t  size = 32 
)
inline

Definition at line 323 of file RayTracer.h.

void openvdb::OPENVDB_VERSION_NAME::tools::Film::fill ( const RGBA rgb = RGBA(0))
inline

Definition at line 322 of file RayTracer.h.

size_t openvdb::OPENVDB_VERSION_NAME::tools::Film::height ( void  ) const
inline

Definition at line 391 of file RayTracer.h.

size_t openvdb::OPENVDB_VERSION_NAME::tools::Film::numPixels ( ) const
inline

Definition at line 392 of file RayTracer.h.

const RGBA& openvdb::OPENVDB_VERSION_NAME::tools::Film::pixel ( size_t  w,
size_t  h 
) const
inline

Definition at line 308 of file RayTracer.h.

RGBA& openvdb::OPENVDB_VERSION_NAME::tools::Film::pixel ( size_t  w,
size_t  h 
)
inline

Definition at line 315 of file RayTracer.h.

const RGBA* openvdb::OPENVDB_VERSION_NAME::tools::Film::pixels ( ) const
inline

Definition at line 393 of file RayTracer.h.

void openvdb::OPENVDB_VERSION_NAME::tools::Film::savePPM ( const std::string fileName)
inline

Definition at line 333 of file RayTracer.h.

size_t openvdb::OPENVDB_VERSION_NAME::tools::Film::width ( ) const
inline

Definition at line 390 of file RayTracer.h.


The documentation for this class was generated from the following file: