HDK
|
Go to the source code of this file.
Classes | |
class | BRAY_HDALoader |
Macros | |
#define | ENUM_FLAG(TOKEN) BRAY_EVENT_##TOKEN = (1 << BRAY_EVENT_##TOKEN##_FLAG) |
#define | PROPERTY_LOOKUP(NAME, STYLE, ENUM) |
#define | ENUM_MAPPER(TYPE, METHOD) |
#define | ENUM_TO_MASK(TOKEN) TOKEN = (1 << TOKEN##_ENUM) |
#define | INSTANTIATE(VAR, SIZE, IS_ARRAY) |
#define | INSTANTIATE(VAR, SIZE, IS_ARRAY) |
Typedefs | |
using | BRAYtime = float |
Consistent representation of time type within BRAY. More... | |
using | BRAYmaterialId = int |
Consistent representation for material ids. More... | |
#define ENUM_FLAG | ( | TOKEN | ) | BRAY_EVENT_##TOKEN = (1 << BRAY_EVENT_##TOKEN##_FLAG) |
Definition at line 37 of file BRAY_Types.h.
#define ENUM_MAPPER | ( | TYPE, | |
METHOD | |||
) |
Definition at line 729 of file BRAY_Types.h.
#define ENUM_TO_MASK | ( | TOKEN | ) | TOKEN = (1 << TOKEN##_ENUM) |
Definition at line 789 of file BRAY_Types.h.
#define INSTANTIATE | ( | VAR, | |
SIZE, | |||
IS_ARRAY | |||
) |
Definition at line 921 of file BRAY_Types.h.
#define INSTANTIATE | ( | VAR, | |
SIZE, | |||
IS_ARRAY | |||
) |
Definition at line 921 of file BRAY_Types.h.
#define PROPERTY_LOOKUP | ( | NAME, | |
STYLE, | |||
ENUM | |||
) |
Definition at line 482 of file BRAY_Types.h.
using BRAYmaterialId = int |
Consistent representation for material ids.
Definition at line 749 of file BRAY_Types.h.
Consistent representation of time type within BRAY.
Definition at line 746 of file BRAY_Types.h.
anonymous enum |
Definition at line 20 of file BRAY_Types.h.
enum BRAY_BucketOrder |
Enumerator | |
---|---|
BRAY_BUCKETORDER_MIDDLE | |
BRAY_BUCKETORDER_TOP | |
BRAY_BUCKETORDER_BOTTOM | |
BRAY_BUCKETORDER_LEFT | |
BRAY_BUCKETORDER_RIGHT | |
BRAY_BUCKETORDER_MAX |
Definition at line 612 of file BRAY_Types.h.
enum BRAY_CameraProperty |
Definition at line 335 of file BRAY_Types.h.
enum BRAY_EventType |
Types of events that can be sent as updates to the renderer.
Enumerator | |
---|---|
BRAY_NO_EVENT | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG | |
ENUM_FLAG |
Definition at line 39 of file BRAY_Types.h.
enum BRAY_ImageMode |
Enumerator | |
---|---|
BRAY_IMAGEMODE_PROGRESSIVE | |
BRAY_IMAGEMODE_BUCKET | |
BRAY_IMAGEMODE_MAX |
Definition at line 623 of file BRAY_Types.h.
enum BRAY_InteractionType |
Enumerator | |
---|---|
BRAY_INTERACTION_NORMAL | |
BRAY_INTERACTION_FLIPBOOK | |
BRAY_INTERACTION_PLAYING | |
BRAY_INTERACTION_SCRUBBING | |
BRAY_INTERACTION_EDITING | |
BRAY_INTERACTION_TUMBLING | |
BRAY_INTERACTION_MAX_TYPES |
Definition at line 600 of file BRAY_Types.h.
enum BRAY_LightProperty |
Definition at line 355 of file BRAY_Types.h.
Enumerator | |
---|---|
BRAY_LSM_UNIFORM | |
BRAY_LSM_LIGHT_TREE |
Definition at line 936 of file BRAY_Types.h.
enum BRAY_LightType |
Definition at line 571 of file BRAY_Types.h.
enum BRAY_LPEPrefix |
List of known LPE prefixes.
Enumerator | |
---|---|
BRAY_LPEPREFIX_NONE | |
BRAY_LPEPREFIX_UNOCCLUDED | |
BRAY_LPEPREFIX_HOLDOUTS |
Definition at line 755 of file BRAY_Types.h.
enum BRAY_ObjectProperty |
Definition at line 221 of file BRAY_Types.h.
enum BRAY_OverrideLight |
Enumerator | |
---|---|
BRAY_OVERRIDE_LIGHT_OFF | |
BRAY_OVERRIDE_LIGHT_EMISSIVE | |
BRAY_OVERRIDE_LIGHT_HEADLIGHT | |
BRAY_OVERRIDE_LIGHT_DOMELIGHT |
Definition at line 563 of file BRAY_Types.h.
enum BRAY_PlaneProperty |
Definition at line 392 of file BRAY_Types.h.
enum BRAY_Projection |
Projection modes for rendering.
Enumerator | |
---|---|
BRAY_PROJ_ORTHOGRAPHIC | |
BRAY_PROJ_PERSPECTIVE | |
BRAY_PROJ_CVEX_SHADER | |
BRAY_PROJ_BAKING | |
BRAY_PROJ_MAX | |
BRAY_PROJ_INVALID |
Definition at line 632 of file BRAY_Types.h.
enum BRAY_PropertyType |
Enumerator | |
---|---|
BRAY_SCENE_PROPERTY | |
BRAY_OBJECT_PROPERTY | |
BRAY_LIGHT_PROPERTY | |
BRAY_CAMERA_PROPERTY | |
BRAY_PLANE_PROPERTY | |
BRAY_MAX_PROPERTY_TYPES | |
BRAY_INVALID_PROPERTY |
Definition at line 406 of file BRAY_Types.h.
enum BRAY_RayVisibility : uint16 |
Ray visibility flags.
Definition at line 791 of file BRAY_Types.h.
Definition at line 772 of file BRAY_Types.h.
enum BRAY_RenderStage |
Enumerator | |
---|---|
BRAY_STAGE_INACTIVE | |
BRAY_STAGE_LOADING | |
BRAY_STAGE_INITIALIZING | |
BRAY_STAGE_GUIDING_TRAINING | |
BRAY_STAGE_RENDERING | |
BRAY_STAGE_CONVERGED | |
BRAY_STAGE_MAX_TYPES |
Definition at line 587 of file BRAY_Types.h.
enum BRAY_SceneOption |
Option tokens used at the "global" (scene) level
Definition at line 66 of file BRAY_Types.h.
enum BRAY_VexLightImport |
Enumerator | |
---|---|
BRAY_LIGHTIMPORT_SURFNORMAL | |
BRAY_LIGHTIMPORT_SURFACEINCIDENT | |
BRAY_LIGHTIMPORT_LIGHTVECTOR | |
BRAY_LIGHTIMPORT_SURFACEPOSITION | |
BRAY_LIGHTIMPORT_MAX | |
BRAY_LIGHTIMPORT_INVALID |
Definition at line 718 of file BRAY_Types.h.
enum BRAY_VexRayImport |
Definition at line 643 of file BRAY_Types.h.
BRAY_API UT_StringHolder BRAYeventType | ( | BRAY_EventType | type | ) |
Create a nice string for the event type mask.
|
inline |
Definition at line 470 of file BRAY_Types.h.
|
inline |
Definition at line 477 of file BRAY_Types.h.
|
inline |
Generic method to return the number of options given an enum
Definition at line 540 of file BRAY_Types.h.
|
inline |
Generic method to return the number of options given an enum
Definition at line 538 of file BRAY_Types.h.
|
inline |
Generic method to return the number of options given an enum
Definition at line 536 of file BRAY_Types.h.
|
inline |
Generic method to return the number of options given an enum
Definition at line 542 of file BRAY_Types.h.
|
inline |
Generic method to return the number of options given an enum
Definition at line 534 of file BRAY_Types.h.
BRAY_API const UT_StringHolder& BRAYproperty | ( | BRAY_PropertyType | ty, |
int | id | ||
) |
BRAY_API int BRAYproperty | ( | BRAY_PropertyType | ty, |
const UT_StringRef & | name | ||
) |
BRAY_API std::pair<BRAY_PropertyType, int> BRAYproperty | ( | const char * | token, |
BRAY_PropertyType | style = BRAY_SCENE_PROPERTY |
||
) |
This function will resolve generic names to the appropriate property type and property identifier. For example: "plane:filter" -> {BRAY_PLANE_PROPERTY, BRAY_PLANE_FILTER} "camera:focal" -> {BRAY_CAMERA_PROPERTY, BRAY_CAMERA_FOCAL} "global:bucketsize" -> {BRAY_SCENE_PROPERTY, BRAY_OPT_BUCKETSIZE} If the token doesn't map to a property, the function will return an invalid pair (i.e. BRAYisValid(result) == false).
If the token isn't prefixed with a property type, the default_style
will be used. For example, with the default of BRAY_SCENE_PROPERTY: "bucketsize" -> { BRAY_SCENE_PROPERTY, BRAY_OPT_BUCKETSIZE } "focal" -> {invalid_property_pair} (error - not a scene property)
BRAY_API const char* BRAYproperty | ( | UT_WorkBuffer & | storage, |
BRAY_PropertyType | type, | ||
int | property_id, | ||
const char * | prefix = "" |
||
) |
Given a property type, this will compose a name string that fully qualifies the property. This is a string that would be suitable for BRAYlookupProperty()
. This may return a nullptr
.
|
inline |
Look up the enum given a name.
Definition at line 443 of file BRAY_Types.h.
BRAY_API exint BRAYpropertySize | ( | BRAY_PropertyType | ty, |
int | id | ||
) |
BRAY_API GT_Storage BRAYpropertyStorage | ( | BRAY_PropertyType | ty, |
int | id | ||
) |
BRAY_API BRAY_PropertyType BRAYpropertyType | ( | const UT_StringRef & | name | ) |
Lookup a property type by name.
BRAY_API const UT_StringHolder& BRAYpropertyType | ( | BRAY_PropertyType | id | ) |
Look up the name of a property type by the id.
|
inline |
Generic method to find the valud of the property type enum given the enum
Definition at line 557 of file BRAY_Types.h.
|
inline |
Generic method to find the valud of the property type enum given the enum
Definition at line 555 of file BRAY_Types.h.
|
inline |
Generic method to find the valud of the property type enum given the enum
Definition at line 553 of file BRAY_Types.h.
|
inline |
Generic method to find the valud of the property type enum given the enum
Definition at line 559 of file BRAY_Types.h.
|
inline |
Generic method to find the valud of the property type enum given the enum
Definition at line 551 of file BRAY_Types.h.
BRAY_API UT_StringHolder BRAYrayVisibility | ( | BRAY_RayVisibility | mask | ) |
BRAY_API const UT_StringHolder& BRAYrendererName | ( | ) |
Return the name of the renderer.
UT_ASSERT_COMPILETIME | ( | BRAY_EVENT_MAXFLAGS<= | 32 | ) |