beastapi/beastinstance.h File Reference
#include "beastapitypes.h"File Description
The api for specifying instances of meshes in Beast.
Typedefs | |
| typedef uint32 | ILBRenderStatsMask |
Enumerations | |
| enum | ILBRenderStatOperation { ILB_RSOP_DISABLE, ILB_RSOP_ENABLE } |
| enum | ILBRenderStats { ILB_RS_VISIBLE_FOR_EYE = 0x00000001, ILB_RS_VISIBLE_FOR_REFLECTIONS = 0x00000002, ILB_RS_VISIBLE_FOR_REFRACTIONS = 0x00000004, ILB_RS_VISIBLE_FOR_GI = 0x00000008, ILB_RS_CAST_SHADOWS = 0x00000010, ILB_RS_RECEIVE_SHADOWS = 0x00000020, ILB_RS_CAST_GI = 0x00000040, ILB_RS_RECEIVE_GI = 0x00000080, ILB_RS_CAST_OCCLUSION = 0x00000100, ILB_RS_RECEIVE_OCCLUSION = 0x00000200, ILB_RS_DOUBLE_SIDED = 0x00000400, ILB_RS_OPPOSITE = 0x00000800, ILB_RS_SELF_OCCLUSION = 0x00001000, ILB_RS_SHADOW_BIAS = 0x00002000, ILB_RS_PRIMARY_VISIBILITY = ILB_RS_VISIBLE_FOR_EYE, ILB_RS_VISIBLE_IN_REFLECTIONS = ILB_RS_VISIBLE_FOR_REFLECTIONS, ILB_RS_VISIBLE_IN_REFRACTIONS = ILB_RS_VISIBLE_FOR_REFRACTIONS, ILB_RS_VISIBLE_IN_FINAL_GATHER = ILB_RS_VISIBLE_FOR_GI } |
Typedef Documentation
| typedef uint32 ILBRenderStatsMask |
Type representing multiple render stats.
Combine render stats using the or operator (|).
Example:
ILBRenderStatsMask rsMask = ILB_RS_SELF_OCCLUSION | ILB_RS_PRIMARY_VISIBILITY;
Enumeration Type Documentation
| enum ILBRenderStats |
Beast render stats.
Function Documentation
| ILBStatus ILBAddInstanceLightLinks | ( | ILBInstanceHandle | instance, |
| ILBLightLinkMode | mode, | ||
| const ILBLightHandle * | lightSources, | ||
| int32 | count | ||
| ) |
Adds an object centric light link list.
- Parameters
-
instance the instance to add light links to mode sets whether the light links are inclusive or exclusive lightSources an array of light sources that should be linked count the number of light sources present in the lightSources array
- Returns
- The result of the operation.
| ILBStatus ILBAddLODInstance | ( | ILBInstanceHandle | lowRes, |
| ILBInstanceHandle | highRes | ||
| ) |
Connects two meshes so one acts as a high resolution instances and one as a lod.
This is used for normal map generation etc. When connected, the low resolution mesh will automatically be set as invisible using renderstats. There can be many high resolution instances for every low resolution instance. An instance can act as high resolution mesh for many low resolution meshes
- Parameters
-
lowRes the instance to act as low resolution mesh in this lod relationship. Will be hidden by this call. highRes the high resolution mesh in this lod relationship
- Returns
- The result of the operation.
| ILBStatus ILBCreateInstance | ( | ILBSceneHandle | scene, |
| ILBMeshHandle | mesh, | ||
| ILBConstString | name, | ||
| const ILBMatrix4x4 * | transform, | ||
| ILBInstanceHandle * | instance | ||
| ) |
Add an instance to the scene.
- Parameters
-
scene the scene the instance should be a part of mesh the mesh the instance should reference name the name of the instance, must be unique within the scene. transform the object space to world space transform for this mesh instance the handle to store the generated instance in
- Returns
- The result of the operation.
Examples:
| ILBStatus ILBDeleteInstance | ( | ILBInstanceHandle | instance | ) |
Deletes an instance from a scene.
Only possible for dynamic scenes, ie. scenes associated with a live ernst job.
- Parameters
-
instance instance to delete
- Returns
- The result of the operation.
| ILBStatus ILBSetInstanceDisplayName | ( | ILBInstanceHandle | instance, |
| ILBConstString | displayName | ||
| ) |
Sets the display name for the instance.
This name does not have to be unique within the scene and can be used by tools to give human understandable names to objects that has names that are generated and for some reason isn't suitable to read
- Parameters
-
instance the instance to set the name for displayName the display name to set
| ILBStatus ILBSetInstanceMesh | ( | ILBInstanceHandle | instance, |
| ILBMeshHandle | mesh | ||
| ) |
Change the mesh of an instance.
- Parameters
-
instance the instance to change the mesh mesh the new mesh
- Returns
- The result of the operation
| ILBStatus ILBSetInstanceMotionTransforms | ( | ILBInstanceHandle | instance, |
| const ILBMatrix4x4 * | transforms, | ||
| int32 | count | ||
| ) |
Sets the motion transforms of a motion blurred instance.
- Parameters
-
instance the instance to change transforms an array of transforms describing the camera motion count the number of transforms in the array
- Returns
- The result of the operation.
| ILBStatus ILBSetInstanceTransform | ( | ILBInstanceHandle | instance, |
| const ILBMatrix4x4 * | transform | ||
| ) |
Sets the transform for an instance.
- Parameters
-
instance the instance to change transform the new transform
- Returns
- The result of the operation.
| ILBStatus ILBSetMaterialOverrides | ( | ILBInstanceHandle | instance, |
| ILBMaterialHandle * | materials, | ||
| int32 | materialCount | ||
| ) |
Overrides materials for this instance.
- Parameters
-
instance the instance to override materials for materials an array of materials to override the one specified in the mesh with. It should be in the same order as the material groups in the mesh. A 0 pointer will keep the default material. If the material lists size doesn't match, unassigned materials will stay default and overflowing materials will be ignored. materialCount the number of override materials available in the materials array.
- Returns
- The result of the operation.
- Examples:
| ILBStatus ILBSetRenderStats | ( | ILBInstanceHandle | instance, |
| ILBRenderStatsMask | stats, | ||
| ILBRenderStatOperation | operation | ||
| ) |
Sets render stats on an instance.
- Parameters
-
instance the instance to set the render stats on stats the stats to modify. Can be multiple render stats or:ed together operation selects whether to enable or disable the selected render stats.
- Returns
- The result of the operation.
- Examples: