RenderOptions encapsulates render options in a clear and concise way. The options can be persisted as a dictionary using getDict() and fed to RenderOptions(dict=your_dict) when employing it.
The rendering mode can be found by the "render_mode" key of the dictionary. It can have three values: lux.RENDER_MODE_ADVANCED, lux.RENDER_MODE_TIME, or lux.RENDER_MODE_SAMPLES.
Get an instance of the current render options using lux.getRenderOptions().
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
- getDict(...)
- Get specified options as a dictionary. This can be useful to persist options and then supply to a lux.RenderOptions() constructor when needed to render something. Be wary of the version specified in the dictionary, key values will be converted to the latest version automatically.
- setAddToQueue(...)
- Instead of rendering immediately then it will be added to the internal KeyShot queue, waiting for processing. Note that a copy of the scene will be saved to disk each time. Call lux.processQueue() to process the queue and render what has been added to it.
add = Whether to add to queue or not. *
- setAdvancedRendering(...)
- Render in advanced mode with specified samples.
samples = The number of samples. *
- setAntiAliasing(...)
- Set anti aliasing level.
level = Value from 1 to 8. *
- setBackgroundRendering(...)
- Render in external background process. Note that a background window will open and the call-site will return immediately!
ext = Whether to render in background or not. *
- setCausticsQuality(...)
- Set caustics quality.
quality = Value from 0 to 10 (0 will disable it). *
- setDofQuality(...)
- Set depth-of-field quality.
quality = Value from 1 to 10. *
- setGlobalIllumination(...)
- Set global illumination quality.
quality = Quality from 0 to 5 (0 will disable it). *
- setGlobalIlluminationCache(...)
- Set whether or not to use global illumination cache.
enable = Use cache. *
- setIndirectBounces(...)
- Set the number of indirect bounces.
bounces = The number of indirect bounces. *
- setMaxSamplesRendering(...)
- Render until max samples is reached.
samples = Maximum samples. *
- setMaxTimeRendering(...)
- Render the amount of time specified.
time = Time in seconds (floating-point number). *
- setOutputAlphaChannel(...)
- Set whether to have alpha channel in output image.
enable = Use alpha channel or not. *
- setOutputAmbientOcclusionPass(...)
- Output ambient occlusion pass separate to the result.
enable = Output ambient occlusion pass. *
- setOutputCausticsPass(...)
- Output caustics pass separate to the result.
enable = Output caustics pass. *
- setOutputClownPass(...)
- Output clown pass separate to the result.
enable = Output clown pass. *
- setOutputDepthPass(...)
- Output depth pass separate to the result.
enable = Output depth pass. *
- setOutputDiffusePass(...)
- Output diffuse pass separate to the result.
enable = Output diffuse pass. *
- setOutputDirectLightingPass(...)
- Output direct lighting pass separate to the result.
enable = Output direct lighting pass. *
- setOutputIndirectLightingPass(...)
- Output indirect lighting pass separate to the result.
enable = Output indirect lighting pass. *
- setOutputNormalsPass(...)
- Output normals pass separate to the result.
enable = Output normals pass. *
- setOutputReflectionPass(...)
- Output reflection pass separate to the result.
enable = Output reflection pass. *
- setOutputRefractionPass(...)
- Output refraction pass separate to the result.
enable = Output refraction pass. *
- setOutputRenderLayers(...)
- Output render layers separate to the result
enable = Output render layers. *
- setOutputShadowPass(...)
- Output shadow pass separate to the result.
enable = Output shadow pass. *
- setPixelBlur(...)
- Set pixel blur.
blur = Value from 1 to 3. *
- setRayBounces(...)
- Set the number of ray bounces.
bounces = The number of ray bounces. *
- setRegion(...)
- Set render region to get subset of image.
region = Tuple/list of (start x-axis, start y-axis, end x-axis, end y-axis). Use None to unset a region. *
- setSendToNetwork(...)
- Instead of rendering locally it can be done using KeyShot Network Rendering.
send = Whether to send to network or not. *
- setShadowQuality(...)
- Set shadow quality.
quality = Value from 1 to 10. *
- setSharpShadows(...)
- Set whether to have sharp shadows or not.
enable = Output sharp shadows. *
- setSharperTextureFiltering(...)
- Set whether or not to preserve detail in textures when viewed at grazing angles.
enable = Output sharper texture filtering. *
- setThreads(...)
- Set the number of rendering threads. Zero threads means one thread per core.
threads = The number of threads. *
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- __hash__ = None