ART

Type Aliases

void(* ProgressCallback

Fields

	`PT_GRASS`
	`PT_BUSHES`
	`PT_STONES`
	`PT_TREES`
	`PT_SIZE`
	`CCS_OPACITY`
	`CCS_SIZE`
	`S_FRONT`
	`S_BACK`
	`S_LEFT`
	`S_RIGHT`
	`S_BOTTOM`
	`S_TOP`
	`GS_OPAQUE`
	`GS_TRANSPARENT`
	`GS_MASKED`
	`GS_EMISSIVE`
	`GS_PBR_OPAQUE`
	`GS_WATER`
	`GS_COUNT`
	`LT_NONE`
	`LT_POINT`
	`LT_AREA`
	`LT_SPHERE`
	`LT_OTHER`
	`LB_NONE`
	`LB_FULL`
	`LB_INDIRECT`
	`LS_NONE`
	`LS_DYNAMIC`
	`LS_STATIC`
	`MT_REALISTIC`
	`MT_EMISSIVE`
	`MT_PBR_METALLIC`
	`MT_WATER`
	`DM_SHADED`
	`DM_SHADED_NO_SKY`
	`DM_SHADED_NO_SUN`
	`DM_OBJECT_DIFFUSION`
	`DM_OBJECT_REFLECTION`
	`DM_OBJECT_TRANSLUCENCY`
	`DM_OBJECT_NORMAL`
	`DM_OBJECT_AO`
	`DM_OBJECT_GI`
	`DM_OBJECT_MOTION`
	`DM_OBJECT_ID`
	`DM_SIZE`
	`AS_LANDSCAPE`
	`AS_PRISMS`
	`AS_CLOUDS`
	`AS_SIZE`
	`PID_CUSTOM`
	`PID_MERCURY`
	`PID_VENUS`
	`PID_EARTH`
	`PID_MARS`
	`PID_JUPITER`
	`PID_SATURN`
	`PID_URANUS`
	`PID_NEPTUNE`
	`PID_MOON`
	`PID_PHOBOS`
	`PID_DEIMOS`
	`PID_IO`
	`PID_EUROPA`
	`PID_GANYMEDE`
	`PID_CALLISTO`
	`PID_MIMAS`
	`PID_ENCELADUS`
	`PID_TETHYS`
	`PID_DIONE`
	`PID_RHEA`
	`PID_TITAN`
	`PID_IAPETUS`
	`PID_MIRANDA`
	`PID_ARIEL`
	`PID_UMBRIEL`
	`PID_TITANIA`
	`PID_OBERON`
	`PID_NAIAD`
	`PID_THALASSA`
	`PID_DESPINA`
	`PID_GALATEA`
	`PID_LARISSA`
	`PID_PROTEUS`
	`PID_TRITON`
	`PID_NEREID`
	`PID_SIZE`
	`RPT_SPHERE`
	`RPT_BOX`
	`RPT_PLANAR`
	`SID_CUSTOM`
	`SID_SUN`
	`SID_SIZE`

Detailed Description

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

Type Documentation

enum ART::PRISM_TYPE

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).

Values:

enumerator PT_GRASS: Grass level plants. Are influenced by bushes and trees.

enumerator PT_BUSHES: Bushes and small plants. Are influenced by trees.

enumerator PT_STONES: Stones. Are influenced by trees.

enumerator PT_TREES: Trees.

enumerator PT_SIZE: Number of entries in the ART::PRISM_TYPE enumeration.

enum ART::CLOUDS_COVER_SOURCE

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

Values:

enumerator CCS_OPACITY: Opacity source.

enumerator CCS_SIZE: Number of entries in the ART::CLOUDS_COVER_SOURCE enumeration.

enum ART::SIDE

Lists cube sides.

Values:

enumerator S_FRONT: Front side.

enumerator S_BACK: Back side.

enumerator S_LEFT: Left side.

enumerator S_RIGHT: Right side.

enumerator S_BOTTOM: Bottom side.

enumerator S_TOP: Top side.

enum ART::GEOMETRY_SHAPE

Lists all types of shapes under the geometry.

Values:

enumerator GS_OPAQUE: Opaque shape.

enumerator GS_TRANSPARENT: Transparent shape.

enumerator GS_MASKED: Masked shape.

enumerator GS_EMISSIVE: Emissive shape.

enumerator GS_PBR_OPAQUE: PBR opaque shape.

enumerator GS_WATER: Water shape.

enumerator GS_COUNT: Total number of shape types.

enum ART::LIGHT_TYPE

Lists all the types of lights.

Values:

enumerator LT_NONE: Unspecified light type.

enumerator LT_POINT: Point light type.

enumerator LT_AREA: Physical area light type.

enumerator LT_SPHERE: Physical spherical light type.

enumerator LT_OTHER: All other light types.

enum ART::LIGHT_BAKING

Lists all the light baking modes.

Values:

enumerator LB_NONE: No light baking.

enumerator LB_FULL: Full light baking.

enumerator LB_INDIRECT: Baking for indirect lighting only.

enum ART::LIGHT_SHADOW

Lists all the light shadow modes.

Values:

enumerator LS_NONE: No light shadow.

enumerator LS_DYNAMIC: Dynamic light shadow map.

enumerator LS_STATIC: Static light shadow map.

enum ART::MATERIAL_TYPE

Lists all types of material.

Values:

enumerator MT_REALISTIC: Realistic material.

enumerator MT_EMISSIVE: Emissive material.

enumerator MT_PBR_METALLIC: PBR metallic material.

enumerator MT_WATER

enum ART::DISPLAY_MODE

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

Values:

enumerator DM_SHADED: Default display mode using shading.

enumerator DM_SHADED_NO_SKY: Display mode using shading without the atmospheric shading pass. Atmospheric scattering is disabled.

enumerator DM_SHADED_NO_SUN: Display mode using shading without the sun shading pass. Atmospheric scattering is disabled.

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

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

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

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

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

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

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

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

enumerator DM_SIZE: Size of the display mode enumeration.

enum ART::ATMOSPHERIC_SAMPLE

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

Values:

enumerator AS_LANDSCAPE: Samples used for the determination of the effects of the atmosphere over the landscape.

enumerator AS_PRISMS: Samples used for the determination of the effects of the atmosphere over prisms.

enumerator AS_CLOUDS: Samples used for the determination of the effects of the atmosphere over clouds.

enumerator AS_SIZE: Size of this enumeration.

enum ART::PLANET_ID

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.

Values:

enumerator PID_CUSTOM: Flag used for custom planets or small satellites.

enumerator PID_MERCURY: Identifies the Mercury planet.

enumerator PID_VENUS: Identifies the Venus planet.

enumerator PID_EARTH: Identifies the Earth planet.

enumerator PID_MARS: Identifies the Mars planet.

enumerator PID_JUPITER: Identifies the Jupiter planet.

enumerator PID_SATURN: Identifies the Saturn planet.

enumerator PID_URANUS: Identifies the Uranus planet.

enumerator PID_NEPTUNE: Identifies the Neptune planet.

enumerator PID_MOON: Identifies an Earth satellite.

enumerator PID_PHOBOS: Identifies a Mars satellite.

enumerator PID_DEIMOS: Identifies a Mars satellite.

enumerator PID_IO: Identifies a Jupiter satellite.

enumerator PID_EUROPA: Identifies a Jupiter satellite.

enumerator PID_GANYMEDE: Identifies a Jupiter satellite.

enumerator PID_CALLISTO: Identifies a Jupiter satellite.

enumerator PID_MIMAS: Identifies a Saturn satellite.

enumerator PID_ENCELADUS: Identifies a Saturn satellite.

enumerator PID_TETHYS: Identifies a Saturn satellite.

enumerator PID_DIONE: Identifies a Saturn satellite.

enumerator PID_RHEA: Identifies a Saturn satellite.

enumerator PID_TITAN: Identifies a Saturn satellite.

enumerator PID_IAPETUS: Identifies a Saturn satellite.

enumerator PID_MIRANDA: Identifies an Uranus satellite.

enumerator PID_ARIEL: Identifies an Uranus satellite.

enumerator PID_UMBRIEL: Identifies an Uranus satellite.

enumerator PID_TITANIA: Identifies an Uranus satellite.

enumerator PID_OBERON: Identifies an Uranus satellite.

enumerator PID_NAIAD: Identifies an Neptune satellite.

enumerator PID_THALASSA: Identifies an Neptune satellite.

enumerator PID_DESPINA: Identifies a Neptune satellite.

enumerator PID_GALATEA: Identifies a Neptune satellite.

enumerator PID_LARISSA: Identifies a Neptune satellite.

enumerator PID_PROTEUS: Identifies a Neptune satellite.

enumerator PID_TRITON: Identifies a Neptune satellite.

enumerator PID_NEREID: Identifies a Neptune satellite.

enumerator PID_SIZE

enum ART::REFLECTION_PROBE_TYPE

Lists all types of reflection probes.

Values:

enumerator RPT_SPHERE: Spherical probe.

enumerator RPT_BOX: Box probe.

enumerator RPT_PLANAR: Planar probe.

enum ART::STAR_ID

Lists all known solar system stars.

Values:

enumerator SID_CUSTOM: Identifies a custom star.

enumerator SID_SUN: Identifies our Sun.

enumerator SID_SIZE

Type Alias Documentation

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

Progress callback declaration.

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

	Factory
	IAssetManager
	IAtlas
	ICamera
	IEntity
	IGeometry
	ILight
	IMaterial
	IObserver
	IOptions
	IPlanet
	IReflectionProbe
	IStar
	IStatistics
	IWorld
	`PRISM_TYPE`
	`CLOUDS_COVER_SOURCE`
	`SIDE`
	`GEOMETRY_SHAPE`
	`LIGHT_TYPE`
	`LIGHT_BAKING`
	`LIGHT_SHADOW`
	`MATERIAL_TYPE`
	`DISPLAY_MODE`
	`ATMOSPHERIC_SAMPLE`
	`PLANET_ID`
	`REFLECTION_PROBE_TYPE`
	`STAR_ID`

ART

Types

Type Aliases

Fields

Detailed Description

Type Documentation

Type Alias Documentation