All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Member Functions | Public Attributes | Friends | List of all members
HdEmbreeConfig Class Reference

This class is a singleton, holding configuration parameters for HdEmbree. More...

Static Public Member Functions

static const HdEmbreeConfig & GetInstance ()
 Return the configuration singleton. More...
 

Public Attributes

unsigned int samplesToConvergence
 How many samples do we need before a pixel is considered converged? More...
 
unsigned int tileSize
 How many pixels are in an atomic unit of parallel work? A work item is a square of size [tileSize x tileSize] pixels. More...
 
unsigned int ambientOcclusionSamples
 How many ambient occlusion rays should we generate per camera ray? More...
 
bool jitterCamera
 Should the renderpass jitter camera rays for antialiasing? More...
 
bool useFaceColors
 Should the renderpass use the color primvar, or flat white colors? (Flat white shows off ambient occlusion better). More...
 
float cameraLightIntensity
 What should the intensity of the camera light be, specified as a percent of <1, 1, 1>. More...
 

Friends

class TfSingleton< HdEmbreeConfig >
 

Detailed Description

This class is a singleton, holding configuration parameters for HdEmbree.

Everything is provided with a default, but can be overridden using environment variables before launching a hydra process.

Many of the parameters can be used to control quality/performance tradeoffs, or to alter how HdEmbree takes advantage of parallelism.

At startup, this class will print config parameters if HDEMBREE_PRINT_CONFIGURATION is true. Integer values greater than zero are considered "true".

Definition at line 45 of file config.h.

Member Function Documentation

static const HdEmbreeConfig& GetInstance ( )
static

Return the configuration singleton.

Member Data Documentation

unsigned int ambientOcclusionSamples

How many ambient occlusion rays should we generate per camera ray?

Override with HDEMBREE_AMBIENT_OCCLUSION_SAMPLES.

Definition at line 66 of file config.h.

float cameraLightIntensity

What should the intensity of the camera light be, specified as a percent of <1, 1, 1>.

For example, 300 would be <3, 3, 3>.

Override with HDEMBREE_CAMERA_LIGHT_INTENSITY.

Definition at line 85 of file config.h.

bool jitterCamera

Should the renderpass jitter camera rays for antialiasing?

Override with HDEMBREE_JITTER_CAMERA. Integer values greater than zero are considered "true".

Definition at line 72 of file config.h.

unsigned int samplesToConvergence

How many samples do we need before a pixel is considered converged?

Override with HDEMBREE_SAMPLES_TO_CONVERGENCE.

Definition at line 54 of file config.h.

unsigned int tileSize

How many pixels are in an atomic unit of parallel work? A work item is a square of size [tileSize x tileSize] pixels.

Override with HDEMBREE_TILE_SIZE.

Definition at line 60 of file config.h.

bool useFaceColors

Should the renderpass use the color primvar, or flat white colors? (Flat white shows off ambient occlusion better).

Override with HDEMBREE_USE_FACE_COLORS. Integer values greater than zero are considered "true".

Definition at line 79 of file config.h.

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