Loading...
Searching...
No Matches
HdEmbreeConfig Class Reference

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

#include <config.h>

Static Public Member Functions

static const HdEmbreeConfigGetInstance ()
 Return the configuration singleton.
 

Public Attributes

unsigned int samplesToConvergence = HdEmbreeDefaultSamplesToConvergence
 How many samples do we need before a pixel is considered converged?
 
unsigned int tileSize = HdEmbreeDefaultTileSize
 How many pixels are in an atomic unit of parallel work? A work item is a square of size [tileSize x tileSize] pixels.
 
unsigned int ambientOcclusionSamples = HdEmbreeDefaultAmbientOcclusionSamples
 How many ambient occlusion rays should we generate per camera ray?
 
bool jitterCamera = HdEmbreeDefaultJitterCamera
 Should the renderpass jitter camera rays for antialiasing?
 
bool useFaceColors = HdEmbreeDefaultUseFaceColors
 Should the renderpass use the color primvar, or flat white colors? (Flat white shows off ambient occlusion better).
 
float cameraLightIntensity = HdEmbreeDefaultCameraLightIntensity
 What should the intensity of the camera light be, specified as a percent of <1, 1, 1>.
 
int randomNumberSeed = HdEmbreeDefaultRandomNumberSeed
 Seed to give to the random number generator.
 
bool useLighting = HdEmbreeDefaultUseLighting
 Should the renderpass use scene lights (in particular, UsdLux-compliant area lights)? Note that if scene lights and ambient occlusion are both enabled, the renderer will choose scene lights rather than ambient occlusion.
 

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 39 of file config.h.

Member Function Documentation

◆ GetInstance()

static const HdEmbreeConfig & GetInstance ( )
static

Return the configuration singleton.

Friends And Related Function Documentation

◆ TfSingleton< HdEmbreeConfig >

friend class TfSingleton< HdEmbreeConfig >
friend

Definition at line 109 of file config.h.

Member Data Documentation

◆ ambientOcclusionSamples

unsigned int ambientOcclusionSamples = HdEmbreeDefaultAmbientOcclusionSamples

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

Override with HDEMBREE_AMBIENT_OCCLUSION_SAMPLES.

Definition at line 61 of file config.h.

◆ cameraLightIntensity

float cameraLightIntensity = HdEmbreeDefaultCameraLightIntensity

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 82 of file config.h.

◆ jitterCamera

bool jitterCamera = HdEmbreeDefaultJitterCamera

Should the renderpass jitter camera rays for antialiasing?

Override with HDEMBREE_JITTER_CAMERA. The case-insensitive strings "true", "yes", "on", and "1" are considered true; an empty value uses the default, and all other values are false.

Definition at line 68 of file config.h.

◆ randomNumberSeed

int randomNumberSeed = HdEmbreeDefaultRandomNumberSeed

Seed to give to the random number generator.

A value of anything other than -1, combined with setting PXR_WORK_THREAD_LIMIT=1, should give deterministic / repeatable results. A value of -1 (the default) will allow the implementation to set a value that varies from invocation to invocation and thread to thread.

Override with HDEMBREE_RANDOM_NUMBER_SEED.

Definition at line 91 of file config.h.

◆ samplesToConvergence

unsigned int samplesToConvergence = HdEmbreeDefaultSamplesToConvergence

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

Override with HDEMBREE_SAMPLES_TO_CONVERGENCE.

Definition at line 49 of file config.h.

◆ tileSize

unsigned int tileSize = HdEmbreeDefaultTileSize

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 55 of file config.h.

◆ useFaceColors

bool useFaceColors = HdEmbreeDefaultUseFaceColors

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

Override with HDEMBREE_USE_FACE_COLORS. The case-insensitive strings "true", "yes", "on", and "1" are considered true; an empty value uses the default, and all other values are false.

Definition at line 76 of file config.h.

◆ useLighting

bool useLighting = HdEmbreeDefaultUseLighting

Should the renderpass use scene lights (in particular, UsdLux-compliant area lights)? Note that if scene lights and ambient occlusion are both enabled, the renderer will choose scene lights rather than ambient occlusion.

Override with HDEMBREE_USE_LIGHTING.

Definition at line 99 of file config.h.


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