namespace ART

Namespace of all REDsdk advanced real-time (ART) interfaces and classes.

Classes:

classFactory
classIAssetManager
classICamera
classIEntity
classIGeometry
classILight
classIMaterial
classIObserver
classIOptions
classIPlanet
classIReflectionProbe
classIStar
classIStatistics
classIWorld

Enumerations:

enumATMOSPHERIC_SAMPLE { AS_LANDSCAPE =  0, AS_PRISMS =  1, AS_CLOUDS =  2, AS_SIZE =  3 }
enumCLOUDS_COVER_SOURCE { CCS_OPACITY =  0, CCS_SIZE =  1 }
enumDISPLAY_MODE { DM_SHADED =  0, DM_SHADED_NO_SKY =  1, DM_SHADED_NO_SUN =  2, DM_OBJECT_DIFFUSION =  3, DM_OBJECT_REFLECTION =  4, DM_OBJECT_TRANSLUCENCY =  5, DM_OBJECT_NORMAL =  6, DM_OBJECT_AO =  7, DM_OBJECT_GI =  8, DM_OBJECT_MOTION =  9, DM_OBJECT_ID =  10, DM_SIZE =  11 }
enumLIGHT_BAKING { LB_NONE =  0, LB_FULL =  1, LB_INDIRECT =  2 }
enumLIGHT_SHADOW { LS_NONE =  0, LS_DYNAMIC =  1, LS_STATIC =  2 }
enumLIGHT_TYPE { LT_NONE =  0, LT_POINT = , LT_AREA = , LT_SPHERE = , LT_OTHER =  }
enumMEMORY { M_CPU =  0, M_GPU =  1 }
enumPLANET_ID { PID_CUSTOM =  0, PID_MERCURY =  1, PID_VENUS =  2, PID_EARTH =  3, PID_MARS =  4, PID_JUPITER =  5, PID_SATURN =  6, PID_URANUS =  7, PID_NEPTUNE =  8, PID_MOON =  9, PID_PHOBOS =  10, PID_DEIMOS =  11, PID_IO =  12, PID_EUROPA =  13, PID_GANYMEDE =  14, PID_CALLISTO =  15, PID_MIMAS =  16, PID_ENCELADUS =  17, PID_TETHYS =  18, PID_DIONE =  19, PID_RHEA =  20, PID_TITAN =  21, PID_IAPETUS =  22, PID_MIRANDA =  23, PID_ARIEL =  24, PID_UMBRIEL =  25, PID_TITANIA =  26, PID_OBERON =  27, PID_NAIAD =  28, PID_THALASSA =  29, PID_DESPINA =  30, PID_GALATEA =  31, PID_LARISSA =  32, PID_PROTEUS =  33, PID_TRITON =  34, PID_NEREID =  35, PID_SIZE =  36 }
enumPRISM_TYPE { PT_GRASS =  0, PT_BUSHES =  1, PT_STONES =  2, PT_TREES =  3, PT_SIZE =  4 }
enumREFLECTION_PROBE_TYPE { RPT_SPHERE =  0, RPT_BOX =  1 }
enumSIDE { S_FRONT =  0, S_BACK =  1, S_LEFT =  2, S_RIGHT =  3, S_BOTTOM =  4, S_TOP =  5 }
enumSTAR_ID { SID_CUSTOM =  0, SID_SUN =  1, SID_SIZE =  2 }

Typedefs:

typedef void(*ProgressCallback )(const RED::String &iMessage, float iActionProgress, float iProgress, void *iParam)

Enumerations documentation

Lists the categories of atmospheric samples that can be processed to calculate effects of the atmosphere over the scene.

Enumerator:

AS_LANDSCAPE

Samples used for the determination of the effects of the atmosphere over the landscape.

AS_PRISMS

Samples used for the determination of the effects of the atmosphere over prisms.

AS_CLOUDS

Samples used for the determination of the effects of the atmosphere over clouds.

AS_SIZE

Size of this enumeration.

Lists all clouds source texture used for the definition of a clouds cover.

Enumerator:

CCS_OPACITY

Opacity source.

CCS_SIZE

Number of entries in the ART::CLOUDS_COVER_SOURCE enumeration.

Lists all available display modes at a global world level that change the rendering of the world.

Enumerator:

DM_SHADED

Default display mode using shading.

DM_SHADED_NO_SKY

Display mode using shading without the atmospheric shading pass. Atmospheric scattering is disabled.

DM_SHADED_NO_SUN

Display mode using shading without the sun shading pass. Atmospheric scattering is disabled.

DM_OBJECT_DIFFUSION

Diffusion color display mode: all visualized entities are seen using their diffusion color.

DM_OBJECT_REFLECTION

Reflection color display mode: all visualized entities are seen using their reflection color.

DM_OBJECT_TRANSLUCENCY

Translucency color display mode: all visualized entities are seen using their translucency color.

DM_OBJECT_NORMAL

Normal display mode: all visualized entities are seen using their normals as plain RGB vectors.

DM_OBJECT_AO

Ambient occlusion display mode: all visualized entities are seen using their AO value.

DM_OBJECT_GI

GI color display mode: all visualized entities are seen using their GI color.

DM_OBJECT_MOTION

Motion vectors display mode: all visualized entities are seen using their motion vectors.

DM_OBJECT_ID

Object ID display mode: all visualized entities are seen using their OID value.

DM_SIZE

Size of the display mode enumeration.

Lists all the light baking modes.

Enumerator:

LB_NONE

No light baking.

LB_FULL

Full light baking.

LB_INDIRECT

Baking for indirect lighting only.

Lists all the light shadow modes.

Enumerator:

LS_NONE

No light shadow.

LS_DYNAMIC

Dynamic light shadow map.

LS_STATIC

Static light shadow map.

Enumerator:

LT_NONE

Unspecified light type.

LT_POINT

Point light type.

LT_AREA

Physical area light type.

LT_SPHERE

Physical spherical light type.

LT_OTHER

All other light types.

Lists memory types.

Enumerator:

M_CPU

CPU Memory.

M_GPU

GPU Memory.

Planet identifier. Identify custom planet types and lists all known solar system planets and their major named satellites. Small and minor satellites are not included in that list, so its not exhaustive.

Enumerator:

PID_CUSTOM

Flag used for custom planets or small satellites.

PID_MERCURY

Identifies the Mercury planet.

PID_VENUS

Identifies the Venus planet.

PID_EARTH

Identifies the Earth planet.

PID_MARS

Identifies the Mars planet.

PID_JUPITER

Identifies the Jupiter planet.

PID_SATURN

Identifies the Saturn planet.

PID_URANUS

Identifies the Uranus planet.

PID_NEPTUNE

Identifies the Neptune planet.

PID_MOON

Identifies an Earth satellite.

PID_PHOBOS

Identifies a Mars satellite.

PID_DEIMOS

Identifies a Mars satellite.

PID_IO

Identifies a Jupiter satellite.

PID_EUROPA

Identifies a Jupiter satellite.

PID_GANYMEDE

Identifies a Jupiter satellite.

PID_CALLISTO

Identifies a Jupiter satellite.

PID_MIMAS

Identifies a Saturn satellite.

PID_ENCELADUS

Identifies a Saturn satellite.

PID_TETHYS

Identifies a Saturn satellite.

PID_DIONE

Identifies a Saturn satellite.

PID_RHEA

Identifies a Saturn satellite.

PID_TITAN

Identifies a Saturn satellite.

PID_IAPETUS

Identifies a Saturn satellite.

PID_MIRANDA

Identifies an Uranus satellite.

PID_ARIEL

Identifies an Uranus satellite.

PID_UMBRIEL

Identifies an Uranus satellite.

PID_TITANIA

Identifies an Uranus satellite.

PID_OBERON

Identifies an Uranus satellite.

PID_NAIAD

Identifies an Neptune satellite.

PID_THALASSA

Identifies an Neptune satellite.

PID_DESPINA

Identifies a Neptune satellite.

PID_GALATEA

Identifies a Neptune satellite.

PID_LARISSA

Identifies a Neptune satellite.

PID_PROTEUS

Identifies a Neptune satellite.

PID_TRITON

Identifies a Neptune satellite.

PID_NEREID

Identifies a Neptune satellite.

PID_SIZE

Lists all categories of prisms. This is an ordered sequence used to apply effects among prisms that belong to different categories (example: trees ao has an effect on underlying grass).

Enumerator:

PT_GRASS

Grass level plants. Are influenced by bushes and trees.

PT_BUSHES

Bushes and small plants. Are influenced by trees.

PT_STONES

Stones. Are influenced by trees.

PT_TREES

Trees.

PT_SIZE

Number of entries in the ART::PRISM_TYPE enumeration.

Lists all types of reflection probes.

Enumerator:

RPT_SPHERE

Spherical probe.

RPT_BOX

Box probe.

Lists cube sides.

Enumerator:

S_FRONT

Front side.

S_BACK

Back side.

S_LEFT

Left side.

S_RIGHT

Right side.

S_BOTTOM

Bottom side.

S_TOP

Top side.

Lists all known solar system stars.

Enumerator:

SID_CUSTOM

Identifies a custom star.

SID_SUN

Identifies our Sun.

SID_SIZE

Types documentation

typedef void(* ART::ProgressCallback)(const RED::String &iMessage, float iActionProgress, float iProgress, void *iParam)

Progress callback declaration.

Parameters:

iMessage:Current action.
iActionProgress:Action progress in [0, 1]; -1 if n/a.
iProgress:Overall progress in [0, 1]; -1 if n/a.
iParam:User parameter.