beastapi/beastjob.h File Reference
#include "beastapitypes.h"File Description
The beast job function definitions.
Enumeration Type Documentation
| enum ILBCausticsModeType |
| enum ILBDistributionType |
| enum ILBErnstRunningState |
| enum ILBJobStatus |
Status codes for Beast API calls.
| enum ILBShowResults |
Sets how to handle the Beast window when rendering.
| enum ILBUpdateType |
Different types of updates which can come from Ernst.
Function Documentation
| ILBStatus ILBCancelJob | ( | ILBJobHandle | job | ) |
Cancels a running job.
- Parameters
-
job the job to cancel
| ILBStatus ILBCreateErnstJob | ( | ILBManagerHandle | beastManager, |
| ILBConstString | uniqueName, | ||
| ILBSceneHandle | scene, | ||
| ILBConstString | jobXML, | ||
| ILBJobHandle * | job | ||
| ) |
Creates an Ernst job.
Ernst jobs works like bake jobs but does not use render passes. All texture and vertex targets added to an Ernst job will be lit in the Ernst session.
- Parameters
-
beastManager the beast manager to create the job for uniqueName a unique name for the job scene the scene to render jobXML the config XML file to use, or an empty string to use defaults for all settings job pointer to where the job handle should be stored
Examples:
| ILBStatus ILBCreateJob | ( | ILBManagerHandle | beastManager, |
| ILBConstString | uniqueName, | ||
| ILBSceneHandle | scene, | ||
| ILBConstString | jobXML, | ||
| ILBJobHandle * | job | ||
| ) |
Creates a Beast job.
- Parameters
-
beastManager the beast manager to create the job for uniqueName a unique name for the job scene the scene to render jobXML the config XML file to use, or an empty string to use defaults for all settings job pointer to where the job handle should be stored
- Examples:
| ILBStatus ILBCreateLiveErnstJob | ( | ILBManagerHandle | beastManager, |
| ILBConstString | uniqueName, | ||
| ILBSceneHandle | scene, | ||
| ILBJobHandle * | job | ||
| ) |
Creates a Live Ernst job.
The scene will be locked and cannot be used for other jobs until the Live Ernst job is done.
- Parameters
-
beastManager the beast manager to create the job for uniqueName a unique name for the job scene the scene to render job pointer to where the job handle should be stored
- Examples:
| ILBStatus ILBCreateUVJob | ( | ILBManagerHandle | beastManager, |
| ILBConstString | uniqueName, | ||
| ILBJobHandle * | job | ||
| ) |
Creates an UV job.
- Parameters
-
beastManager the beast manager to create the job for uniqueName a unique name for the job job pointer to where the job handle should be stored
- Examples:
| ILBStatus ILBDestroyJob | ( | ILBJobHandle | job | ) |
Destroys a job.
- Parameters
-
job the job to destroy
- Examples:
| ILBStatus ILBDestroyUpdate | ( | ILBJobUpdateHandle | update | ) |
Destroys a job update.
- Parameters
-
update the job update to destroy
- Examples:
| ILBStatus ILBExecuteBeast | ( | ILBManagerHandle | bm, |
| ILBJobHandle | job, | ||
| ILBShowResults | showResults, | ||
| ILBDistributionType | distribution, | ||
| ILBJobStatus * | status | ||
| ) |
Convenience function to execute a Beast job.
Blocks until the job is done or fails
- Deprecated:
- This function will go away in the future
- Parameters
-
bm the beast manager to use job the job to execute showResults sets how the beast window should be handled distribution Sets how to distribute the rendering status the result of the rendering
| ILBStatus ILBGetJobProgress | ( | ILBJobHandle | job, |
| ILBStringHandle * | jobName, | ||
| int32 * | progress | ||
| ) |
Gets the current status of a job.
- Parameters
-
job the job to get progress for jobName pointer to a string object that receives the name of job being executed Set to 0 to ignore this parameter. progress to the completion percentage of the current activity
- Examples:
| ILBStatus ILBGetJobResult | ( | ILBJobHandle | job, |
| ILBJobStatus * | status | ||
| ) |
Returns the result of the job as a JobStatus.
- Parameters
-
job the job to get the result for status pointer to the JobStatus
- Examples:
| ILBStatus ILBGetJobUpdate | ( | ILBJobHandle | job, |
| ILBBool * | hasUpdate, | ||
| ILBJobUpdateHandle * | updateHandle | ||
| ) |
Checks if a job has a new update and retrieves it.
- Parameters
-
job the job to get updates from hasUpdate set to true if new update is available updateHandle if hasUpdate is true this will contain a handle to the update
- Examples:
| ILBStatus ILBGetJobUpdateType | ( | ILBJobUpdateHandle | update, |
| ILBUpdateType * | updateType | ||
| ) |
Gets the type of update.
- Parameters
-
update handle to the update updateType returns the update type
- Examples:
| ILBStatus ILBGetUpdateCamera | ( | ILBJobUpdateHandle | update, |
| ILBCameraHandle * | camera | ||
| ) |
Get an updated camera.
- Parameters
-
update the job update camera the updated camera
- Examples:
| ILBStatus ILBGetUpdateFramebuffer | ( | ILBJobUpdateHandle | update, |
| ILBFramebufferHandle * | fb | ||
| ) |
Get an updated frame buffer.
- Parameters
-
update the job update fb the updated frame buffer
- Examples:
| ILBStatus ILBGetUpdateInvalidateFramebuffer | ( | ILBJobUpdateHandle | update, |
| ILBTargetEntityHandle * | te | ||
| ) |
Get the target entity of an invalidated frame buffer update.
- Parameters
-
update the job update te the target entity of the invalidated frame buffer
| ILBStatus ILBGetUpdateLightSource | ( | ILBJobUpdateHandle | update, |
| ILBLightHandle * | light | ||
| ) |
Get an updated light source.
- Parameters
-
update the job update light the updated light source
- Examples:
| ILBStatus ILBGetUpdateSceneInfo | ( | ILBJobUpdateHandle | update, |
| ILBSceneInfoHandle * | sceneInfo | ||
| ) |
Get an updated scene info node.
- Parameters
-
update the job update sceneInfo the updated scene info node
- Examples:
| ILBStatus ILBGetUpdateTargetEntity | ( | ILBJobUpdateHandle | update, |
| ILBTargetEntityHandle * | targetEntity | ||
| ) |
Get an updated target entity.
- Parameters
-
update the job update targetEntity the updated target entity
- Examples:
| ILBStatus ILBIsJobCompleted | ( | ILBJobHandle | job, |
| ILBBool * | result | ||
| ) |
Checks if the job is completed.
Note that a running job can be completed if the user has selected to keep the render window open. A job that is not running might not have finished if it was aborted or had errors.
- Parameters
-
job the job to check result set to true if the job is completed, false otherwise
- Examples:
| ILBStatus ILBIsJobRunning | ( | ILBJobHandle | job, |
| ILBBool * | result | ||
| ) |
Checks if the job is running.
- Parameters
-
job The job to check result Is set to true if job is running, false otherwise
- Examples:
| ILBStatus ILBJobHasNewProgress | ( | ILBJobHandle | job, |
| ILBBool * | newActivity, | ||
| ILBBool * | newProgress | ||
| ) |
Checks if the progress of a Job has been updated since the last time ILBGetJobProgress was called.
- Parameters
-
job The job to check if it has progress newActivity set to true if a new activity has started newProgress set to true if the progress has been updated
- Examples:
| ILBStatus ILBSetCausticsMode | ( | ILBJobHandle | job, |
| ILBCausticsModeType | mode | ||
| ) |
Enables or disables caustics in physical rendering.
- Parameters
-
job the job mode the caustics mode, explained in the enum definition.
| ILBStatus ILBSetErnstDirectIllumination | ( | ILBJobHandle | job, |
| float | illumination | ||
| ) |
Sets the amount of direct illumination to use in a Live Ernst job.
- Parameters
-
job the Live Ernst job illumination the desired amount of direct illumination
| ILBStatus ILBSetErnstDisplayGamma | ( | ILBJobHandle | job, |
| float | displayGamma | ||
| ) |
Sets the display gamma for the Ernst editor.
- Parameters
-
job the Live Ernst job displayGamma the display gamma
| ILBStatus ILBSetErnstGIBakingMode | ( | ILBJobHandle | job, |
| ILBErnstBakingModeType | mode | ||
| ) |
Sets the GI baking mode in a Live Ernst job.
- Parameters
-
job the Live Ernst job mode controls whether to bake what the camera sees or the entire scene
- Examples:
| ILBStatus ILBSetErnstGIDepth | ( | ILBJobHandle | job, |
| int | minDepth, | ||
| int | maxDepth | ||
| ) |
Sets the GI depth in a Live Ernst job.
- Parameters
-
job the Live Ernst job minDepth the minimum depth of a traced path maxDepth the maximum depth of a traced path
| ILBStatus ILBSetErnstGIDiffuseBoost | ( | ILBJobHandle | job, |
| float | boost | ||
| ) |
Sets the GI diffuse boost in a Live Ernst job.
Please refer the Ernst documentation for more information.
- Parameters
-
job the Live Ernst job boost the diffuse boost
| ILBStatus ILBSetErnstGIEmissiveScale | ( | ILBJobHandle | job, |
| float | scale | ||
| ) |
Sets the GI emissive scale in a Live Ernst job.
Please refer the Ernst documentation for more information.
- Parameters
-
job the Live Ernst job scale the emissive scale
| ILBStatus ILBSetErnstGIVarianceLimit | ( | ILBJobHandle | job, |
| float | vl | ||
| ) |
Sets the variance limit in a Live Ernst job.
Please refer the Ernst documentation for more information.
- Parameters
-
job the Live Ernst job vl the variance limit
| ILBStatus ILBSetErnstIndirectIllumination | ( | ILBJobHandle | job, |
| float | illumination | ||
| ) |
Sets the amount of indirect illumination to use in a Live Ernst job.
- Parameters
-
job the Live Ernst job illumination the desired amount of indirect illumination
| ILBStatus ILBSetErnstRunningState | ( | ILBJobHandle | job, |
| ILBErnstRunningState | state | ||
| ) |
Sets the running state of a Live Ernst job.
Allows pausing and restarting a job without terminating it.
- Parameters
-
job the Live Ernst job state whether the job should be paused or running
| ILBStatus ILBSetErnstVarianceThreshold | ( | ILBJobHandle | job, |
| float | threshold | ||
| ) |
Sets the variance threshold in a Live Ernst job.
Please refer the Ernst documentation for more information.
- Parameters
-
job the Live Ernst job threshold the variance threshold
| ILBStatus ILBSetJobLocalProcessingThreads | ( | ILBJobHandle | job, |
| int | numLocalProcessingThreads | ||
| ) |
Sets the number of processing threads on the local submitting machine.
Only available for Ernst jobs. If this function is not called, Ernst will use one thread for every available core.
- Parameters
-
job the job to set directory for numLocalProcessingThreads the number of local threads used
| ILBStatus ILBSetJobOutputPath | ( | ILBJobHandle | job, |
| ILBConstString | path | ||
| ) |
Sets the output directory for the job.
If this function is not called output files will end up in the cache hierarchy.
- Parameters
-
job the job to set directory for path the path to the output directory
| ILBStatus ILBSetJobRenderDepth | ( | ILBJobHandle | job, |
| int | minDepth, | ||
| int | maxDepth | ||
| ) |
Sets the minimum and maximum number of light bounces to use for rendering.
- Parameters
-
job the job minDepth the minimum depth of a traced path maxDepth the maximum depth of a traced path
- Examples:
| ILBStatus ILBSetJobRenderQuality | ( | ILBJobHandle | job, |
| float | quality | ||
| ) |
Sets the render quality to use for a job.
The quality value range from 0.0 to 1.0. Default value is 0.5. A low value will give fast but noisy results, a high value will give less noise but longer render times. This quality value will be used to derive appropriate render sampling settings. If you need full control of the sampling settings, you can use the function ILBSetJobRenderSamples instead, to set the sampling settings explicitly.
- Parameters
-
job the job quality the quality value
- Examples:
| ILBStatus ILBSetJobRenderSamples | ( | ILBJobHandle | job, |
| int | minSamples, | ||
| int | maxSamples, | ||
| float | varianceThreshold | ||
| ) |
Explicitly sets the sampling settings to use for a job.
These are automatically derived when using ILBSetJobRenderQuality, so consider using that function instead for a simplified render setup.
- Parameters
-
job the job minSamples the minimum number of samples to use for each pixel maxSamples the maximum number of samples to use for each pixel varianceThreshold the threshold for variance where a pixel is considered to be sampled well enough
| ILBStatus ILBStartJob | ( | ILBJobHandle | job, |
| ILBShowResults | showResults, | ||
| ILBDistributionType | distribution | ||
| ) |
Starts a job.
- Parameters
-
job the job to start showResults Specifies the behaviour of the render window distribution Sets how to distribute the rendering
- Examples:
| ILBStatus ILBWaitJobDone | ( | ILBJobHandle | job, |
| int32 | timeout | ||
| ) |
Waits until a job is done or until there is progress updates.
- Parameters
-
job The job to wait for timeout The maximum time to wait in milliseconds
- Examples: