rpr_context_info

Usage

Information and flags set on rpr_context.

Possible Values

Name	Value	Brief Explanation
RPR_CONTEXT_CREATION_FLAGS	0x102	Creation Flags, Devices set on context creation. Use a bitwise | operator to use multiple devices.
RPR_CONTEXT_CACHE_PATH	0x103	String cache path for compiled kernels.
RPR_CONTEXT_RENDER_STATUS	0x104	Current render status.
RPR_CONTEXT_RENDER_STATISTICS	0x105	information on render statistics.
RPR_CONTEXT_DEVICE_COUNT	0x106	Number of available devices.
RPR_CONTEXT_PARAMETER_COUNT	0x107	Number of set parameters.
RPR_CONTEXT_ACTIVE_PLUGIN	0x108	String filename of the active RPR plug-in.
RPR_CONTEXT_SCENE	0x109	rpr_scene set for this context.
RPR_CONTEXT_ITERATIONS	0x10B	Number of iterations performed for current render.
RPR_CONTEXT_IMAGE_FILTER_TYPE	0x10C	Antialiasing filter method.
RPR_CONTEXT_IMAGE_FILTER_BOX_RADIUS	0x10D	Radius of filter if this method selected.
RPR_CONTEXT_IMAGE_FILTER_GAUSSIAN_RADIUS	0x10E	Radius of filter if this method selected.
RPR_CONTEXT_IMAGE_FILTER_TRIANGLE_RADIUS	0x10F	Radius of filter if this method selected.
RPR_CONTEXT_IMAGE_FILTER_MITCHELL_RADIUS	0x110	Radius of filter if this method selected.
RPR_CONTEXT_IMAGE_FILTER_LANCZOS_RADIUS	0x111	Radius of filter if this method selected.
RPR_CONTEXT_IMAGE_FILTER_BLACKMANHARRIS_RADIUS	0x112	Radius of filter if this method selected.
RPR_CONTEXT_TONE_MAPPING_TYPE	0x113	Type of tonemapping correction set (if any).
RPR_CONTEXT_TONE_MAPPING_LINEAR_SCALE	0x114	Scale if linear tonemapper selected.
RPR_CONTEXT_TONE_MAPPING_PHOTO_LINEAR_SENSITIVITY	0x115	Sensitivity if photo tonemapper selected.
RPR_CONTEXT_TONE_MAPPING_PHOTO_LINEAR_EXPOSURE	0x116	Exposure if photo tonemapper selected.
RPR_CONTEXT_TONE_MAPPING_PHOTO_LINEAR_FSTOP	0x117	FStop if photo tonemapper selected.
RPR_CONTEXT_TONE_MAPPING_REINHARD02_PRE_SCALE	0x118	Pre-scale value if Reinhard02 tonemapper selected.
RPR_CONTEXT_TONE_MAPPING_REINHARD02_POST_SCALE	0x119	Post-scale value if Reinhard02 tonemapper selected.
RPR_CONTEXT_TONE_MAPPING_REINHARD02_BURN	0x11A	Burn value if Reinhard02 tonemapper is selected.
RPR_CONTEXT_MAX_RECURSION	0x11B	Maximum raytracing bounces per ray.
RPR_CONTEXT_RAY_CAST_EPISLON	0x11C	Ray bias to be used (in the scene’s units). Change this if black self-intersection artifacts are seen on geometry. Usually small values like .002.
RPR_CONTEXT_RADIANCE_CLAMP	0x11D	Clamping value for bright intensity pixels. This clamps firefly artifacts to an intensity value (try < 10.0).
RPR_CONTEXT_X_FLIP	0x11E	Flip the resulting image in the x direction.
RPR_CONTEXT_Y_FLIP	0x11F	Flip the resulting image in the y direction.
RPR_CONTEXT_TEXTURE_GAMMA	0x120	Set a context wide texture gamma correction.
RPR_CONTEXT_PDF_THRESHOLD	0x121	Threshold for clamping lights.
RPR_CONTEXT_RENDER_MODE	0x122	Render mode selected (Default is global illumination).
RPR_CONTEXT_ROUGHNESS_CAP	0x123	Clamp on roughness to prevent artifacts from overly rough surfaces.
RPR_CONTEXT_DISPLAY_GAMMA	0x124	Gamma correction on the output render.
RPR_CONTEXT_MATERIAL_STACK_SIZE	0x125	Maximum material memory.
RPR_CONTEXT_CUTTING_PLANES	0x126	Clipping plane set.
RPR_CONTEXT_GPU0_NAME	0x127	Name for GPU.
RPR_CONTEXT_GPU1_NAME	0x128	Name for GPU.
RPR_CONTEXT_GPU2_NAME	0x129	Name for GPU.
RPR_CONTEXT_GPU3_NAME	0x12A	Name for GPU.
RPR_CONTEXT_CPU_NAME	0x12B	Name for CPU.
RPR_CONTEXT_GPU4_NAME	0x12C	Name for GPU.
RPR_CONTEXT_GPU5_NAME	0x12D	Name for GPU.
RPR_CONTEXT_GPU6_NAME	0x12E	Name for GPU.
RPR_CONTEXT_GPU7_NAME	0x12F	Name for GPU.
RPR_CONTEXT_TONE_MAPPING_EXPONENTIAL_INTENSITY	0x130	Intensity value if exponential intensity set.
RPR_CONTEXT_FRAMECOUNT	0x131	Frame number.
RPR_CONTEXT_TEXTURE_COMPRESSION	0x132	Whether or not to compress textures on GPU (slower but smaller).
RPR_CONTEXT_AO_RAY_LENGTH	0x133	Context wide length for AO_MAP texture node calculation.
RPR_CONTEXT_OOC_TEXTURE_CACHE	0x134	String filename of texture cache on disk.
RPR_CONTEXT_PREVIEW	0x135	Setting for preview mode. Setting this will tile render to lower resolution for first few iterations.
RPR_CONTEXT_CPU_THREAD_LIMIT	0x136	Number of threads used on CPU.
RPR_CONTEXT_LAST_ERROR_MESSAGE	0x137	Last error message.
RPR_CONTEXT_MAX_DEPTH_DIFFUSE	0x138	Maximum number of bounces for diffuse rays.
RPR_CONTEXT_MAX_DEPTH_GLOSSY	0x139	Maximum number of bounces for reflection rays.
RPR_CONTEXT_OOC_CACHE_PATH	0x13a	OOC cache path on disk for geometry.
RPR_CONTEXT_MAX_DEPTH_REFRACTION	0x13B	Maximum number of bounces for refraction rays.
RPR_CONTEXT_MAX_DEPTH_GLOSSY_REFRACTION	0x13C	Maximum number of bounces for glossy refraction rays.
RPR_CONTEXT_RENDER_LAYER_MASK	0x13D	unsingned int 32 render layer mask for shape.
RPR_CONTEXT_SINGLE_LEVEL_BVH_ENABLED	0x13E	Enable Single level BVH. Faster to build but slower to lookup for complex scenes.
RPR_CONTEXT_TRANSPARENT_BACKGROUND	0x13F	Make the background transparent.
RPR_CONTEXT_MAX_DEPTH_SHADOW	0x140	Maximum number of bounces for shadow rays.
RPR_CONTEXT_API_VERSION	0x141	Corresponds to RPR_API_VERSION.
RPR_CONTEXT_GPU8_NAME	0x142	Name for GPU.
RPR_CONTEXT_GPU9_NAME	0x143	Name for GPU.
RPR_CONTEXT_GPU10_NAME	0x144	Name for GPU.
RPR_CONTEXT_GPU11_NAME	0x145	Name for GPU.
RPR_CONTEXT_GPU12_NAME	0x146	Name for GPU.
RPR_CONTEXT_GPU13_NAME	0x147	Name for GPU.
RPR_CONTEXT_GPU14_NAME	0x148	Name for GPU.
RPR_CONTEXT_GPU15_NAME	0x149	Name for GPU.
RPR_CONTEXT_API_VERSION_MINOR	0x14A	Corresponds to RPR_API_VERSION_MINOR.
RPR_CONTEXT_METAL_PERFORMANCE_SHADER	0x14B	Enable Metal Performance Shader - (0 or 1) - for macOS® only (10.14.+).
RPR_CONTEXT_MIPMAP_LOD_OFFSET	0x150	Mipmap LOD Offset for textures. - Enable Metal Performance Shader - (0 or 1) - for macOS® only (10.14.+).
RPR_CONTEXT_AO_RAY_COUNT	0x151	Number of rays used in AO_MAP nodes.
RPR_CONTEXT_SAMPLER_TYPE	0x152	RPR_CONTEXT_SAMPLER_TYPE used.
RPR_CONTEXT_ADAPTIVE_SAMPLING_TILE_SIZE	0x153	Size of tiles sampled for adaptive sampling. If tile noise variance is < noise threshold, this tile is skipped for future samples.
RPR_CONTEXT_ADAPTIVE_SAMPLING_MIN_SPP	0x154	Minimum samples before noise threshold is tested.
RPR_CONTEXT_ADAPTIVE_SAMPLING_THRESHOLD	0x155	Noise theshold metric. Tiles below this level of noise variance are not given future samples.
RPR_CONTEXT_TILE_SIZE	0x156	Size of tile used for adaptive sampling.
RPR_CONTEXT_LIST_CREATED_CAMERAS	0x157	List of cameras created on this context.
RPR_CONTEXT_LIST_CREATED_MATERIALNODES	0x158	List of material nodes created on this context.
RPR_CONTEXT_LIST_CREATED_LIGHTS	0x159	List of lights created on this context.
RPR_CONTEXT_LIST_CREATED_SHAPES	0x15A	List of shapes created on this context.
RPR_CONTEXT_LIST_CREATED_POSTEFFECTS	0x15B	List of post effects created on this context.
RPR_CONTEXT_LIST_CREATED_HETEROVOLUMES	0x15C	List of heterovolumes created on this context.
RPR_CONTEXT_LIST_CREATED_GRIDS	0x15D	List of grids created on this context.
RPR_CONTEXT_LIST_CREATED_BUFFERS	0x15E	List of buffers created on this context.
RPR_CONTEXT_LIST_CREATED_IMAGES	0x15F	List of images created on this context.
RPR_CONTEXT_LIST_CREATED_FRAMEBUFFERS	0x160	List of framebuffers created on this context.
RPR_CONTEXT_LIST_CREATED_SCENES	0x161	List of scenes created on this context.
RPR_CONTEXT_LIST_CREATED_CURVES	0x162	List of curves created on this context.
RPR_CONTEXT_LIST_CREATED_MATERIALSYSTEM	0x163	List of material systems created on this context.
RPR_CONTEXT_LIST_CREATED_COMPOSITE	0x164	List of composites created on this context.
RPR_CONTEXT_LIST_CREATED_LUT	0x165	List of LUT objects created on this context.
RPR_CONTEXT_AA_ENABLED	0x166	Whether anti-aliasing is enabled.
RPR_CONTEXT_ACTIVE_PIXEL_COUNT	0x167	Number of active pixels if using adaptive sampling. This can be used to determine if all pixels have reached the adaptive threshold.
RPR_CONTEXT_TRACING_ENABLED	0x168	Whether debug tracing is enabled.
RPR_CONTEXT_TRACING_PATH	0x169	Output directory to write tracing data to.
RPR_CONTEXT_TILE_RECT	0x16A	Not used at the moment.
RPR_CONTEXT_PLUGIN_VERSION	0x16B	Version of the currently loaded plugin.
RPR_CONTEXT_RUSSIAN_ROULETTE_DEPTH	0x16C	Ray depth at which rays are randomly terminated.
RPR_CONTEXT_RENDER_UPDATE_CALLBACK_FUNC	0x16E	Function to be called at render updates.
RPR_CONTEXT_RENDER_UPDATE_CALLBACK_DATA	0x16F	Pointer to pass to update function.
RPR_CONTEXT_COMPILE_CALLBACK_FUNC	0x601	Function to call at end of kernel compilation.
RPR_CONTEXT_COMPILE_CALLBACK_DATA	0x602	Pointer to pass to compilation complete function.
RPR_CONTEXT_TEXTURE_CACHE_PATH	0x170	Path to directory to use for texture caching.
RPR_CONTEXT_OCIO_CONFIG_PATH	0x171	Path to an OpenColorIO config file (normally config.ocio) which describes colorspaces for texturing and rendering.
RPR_CONTEXT_OCIO_RENDERING_COLOR_SPACE	0x172	Name of the colorspace to use for rendering.
RPR_CONTEXT_CONTOUR_USE_OBJECTID	0x173	Whether to use object ID for the outline around objects in contour rendering.
RPR_CONTEXT_CONTOUR_USE_MATERIALID	0x174	Whether to use material ID for the outline around objects in contour rendering.
RPR_CONTEXT_CONTOUR_USE_NORMAL	0x175	Whether to use normal for the outline around objects in contour rendering.
RPR_CONTEXT_CONTOUR_USE_UV	0x186	Integer, 0 or 1. If set to 1, UV data is used for contour rendering.
RPR_CONTEXT_CONTOUR_NORMAL_THRESHOLD	0x176	Threshold for change in normal to outline around.
RPR_CONTEXT_CONTOUR_UV_THRESHOLD	0x187	Float value (default is 0.04f). Set the UV threshold for contour. As this value gets lower, contour gets thicker.
RPR_CONTEXT_CONTOUR_UV_SECONDARY	0x194	Integer, 0 or 1 (default is 0). If set to 1, secondary UV is used for contour extraction instead of primary UV.
RPR_CONTEXT_CONTOUR_LINEWIDTH_OBJECTID	0x177	Width of outline around different objectIDs.
RPR_CONTEXT_CONTOUR_LINEWIDTH_MATERIALID	0x178	Width of outline around different material IDs.
RPR_CONTEXT_CONTOUR_LINEWIDTH_NORMAL	0x179	Width of outline around different normals.
RPR_CONTEXT_CONTOUR_LINEWIDTH_UV	0x188	Float value that defines the width of contour lines from UV. Default is 0.f
RPR_CONTEXT_CONTOUR_ANTIALIASING	0x17A	Whether to antialias the contour output.
RPR_CONTEXT_CONTOUR_DEBUG_ENABLED	0x17F	If debug is enabled for contour rendering.
RPR_CONTEXT_BEAUTY_MOTION_BLUR	0x17D	When disabled, if there is motion in scene, the Color output will not have motion blur, but the velocity output will be correct.
RPR_CONTEXT_CAUSTICS_REDUCTION	0x17E	Whether caustic reduction (useful if specular fireflies) is enabled.
RPR_CONTEXT_GPU_MEMORY_LIMIT	0x180	Limit in bytes to use for GPU memory.
RPR_CONTEXT_RENDER_LAYER_LIST	0x181	List of names in render layers.
RPR_CONTEXT_WINDING_ORDER_CORRECTION	0x182	Integer, 0 or 1 (default value). If enabled, RPR takes time to check that all vertices are correctly ordered compared to face normal and fixes them if necessary.
RPR_CONTEXT_DEEP_SUBPIXEL_MERGE_Z_THRESHOLD	0x183	Float used for DeepEXR framebuffer. Z is the depth of each pixel. Depths that are closed enough will be merged. This value controls the threshold.
RPR_CONTEXT_DEEP_GPU_ALLOCATION_LEVEL	0x184	Used for DeepEXR. Integer value that should be in the 1~32 range. This represents speed-memory trade-off on GPU. Default value 4 is advised for most usages. Changing it only affect performance but do not modfify the final generated EXR.
RPR_CONTEXT_DEEP_COLOR_ENABLED	0x185	Integer, 0 or 1. Enables color export in DeepEXR.
RPR_CONTEXT_FOG_COLOR	0x189	RGB Floats. Color of fog. Default is rpr_float4(0.5f,0.5f,0.5f,0.5f).
RPR_CONTEXT_FOG_DISTANCE	0x18A	Float value. This value controls the fog density. Default is -1.f, and the negative value disables the fog. Fog density is computed with exp(-(1/fog.distance)*rayLength. So, smaller values make the fog appear denser, while larger values make it appear less dense.
RPR_CONTEXT_FOG_HEIGHT	0x18B	Float value (default is 2.f). This value changes the height of the fog (the rate of exponential decay) along the directional axis.
RPR_CONTEXT_ATMOSPHERE_VOLUME_COLOR	0x18C	RGB floats. Color of the atmosphere volume. Default is rpr_float4(1.0f,1.0f,1.0f,1.0f).
RPR_CONTEXT_ATMOSPHERE_VOLUME_DENSITY	0x18D	Float value (default is 0.f). This value controls the density of the atmosphere volume.
RPR_CONTEXT_ATMOSPHERE_VOLUME_RADIANCE_CLAMP	0x18F	Float value (default is 100.f). Similar to RPR_CONTEXT_RADIANCE_CLAMP but this float is dedicated to atmosphere volume only. This could be useful to have those two clamps decoupled.
RPR_CONTEXT_FOG_HEIGHT_OFFSET	0x18E	Float value used for fog (default is 0.f). This value offsets the camera position along the directional axis. A larger offset value makes the fog starting point lower.
RPR_CONTEXT_INDIRECT_DOWNSAMPLE	0x190	Currently not used.
RPR_CONTEXT_CRYPTOMATTE_EXTENDED	0x191	Integer, 0 or 1. If set to 1, it enables the extended mode of Cryptomatte AOV. This mode needs Cryptomatte AOV. This extends matte generation to glossy and indirect visibility.
RPR_CONTEXT_CRYPTOMATTE_SPLIT_INDIRECT	0x192	Integer, 0 or 1. Needs RPR_CONTEXT_CRYPTOMATTE_EXTENDED=1 in order to work. If enabled, indirect reflections/refractions of objects have a different ID from direct visibility.
RPR_CONTEXT_FOG_DIRECTION	0x193	Float4 vector. This value controls the direction of the fog. Default is rpr_float4(0.0f,1.0f,0.0f,0.0f) (Y-up).
RPR_CONTEXT_RANDOM_SEED	0x1000	Set the random seed of rendering. Doing two scene renderings with different RANDOM_SEED will result in different noise characteristics in the rendering.
RPR_CONTEXT_IBL_DISPLAY	0x195	Integer, 0 or 1 (default is 1). If set to 1, IBL is shown for the primary ray on color image. If set to 0, IBL for the prmary ray turns to be black.
RPR_CONTEXT_NAME	RPR_OBJECT_NAME	Custom name set with rprObjectSetName().
RPR_CONTEXT_UNIQUE_ID	RPR_OBJECT_UNIQUE_ID	ID for this object.
RPR_CONTEXT_CUSTOM_PTR	RPR_OBJECT_CUSTOM_PTR	Custom pointer, if set on this object.