Ramses Core API

enum class EEffectUniformSemantic

Effect uniform semantic type.

Values:

enumerator Invalid: Invalid semantic.

enumerator ProjectionMatrix: Projection matrix 4x4.

enumerator ModelMatrix: Mesh model matrix 4x4.

enumerator CameraWorldPosition

^ Position, from where the renderer eye looks at the scene in world coordinates

Camera position vector 3

enumerator ViewMatrix: View matrix 4x4.

enumerator ModelViewMatrix: Model-view matrix 4x4.

enumerator ModelViewMatrix33: Model-view matrix 3x3.

enumerator ModelViewProjectionMatrix: Model-view-projection matrix 4x4.

enumerator NormalMatrix: Transposed and inversed MVP matrix for vertex normals.

enumerator DisplayBufferResolution: Resolution of currently set destination display buffer (either display framebuffer or offscreen buffer, does not give RenderTarget resolution)

enumerator TextTexture: Text specific.

enumerator TimeMs: synchronized clock in milliseconds, resets to 0 every ~24 days, i.e. value range is: 0 .. std::numeric_limits<int32_t>::max(). In order to avoid handling the wrap in the shader code or potential overflow issues the value should be reset using ramses::Scene::resetUniformTimeMs(). The value is not reset automatically at startup, but contains the time elapsed since clock epoch.

enum class EEffectAttributeSemantic

Effect attribute semantic type.

Values:

enumerator Invalid: Invalid semantic.

enumerator TextPositions: Text specific - vertex positions input. MUST be of type vec2.

enumerator TextTextureCoordinates: Text specific - texture coordinates input. MUST be of type vec2.

enum class EBlendOperation : uint8_t

Specifies the blending operation.

Values:

enumerator Disabled

enumerator Add

enumerator Subtract

enumerator ReverseSubtract

enumerator Min

enumerator Max

enum class EBlendFactor : uint8_t

Specifies the blending factor used with blending operation.

Values:

enumerator Zero

enumerator One

enumerator SrcAlpha

enumerator OneMinusSrcAlpha

enumerator DstAlpha

enumerator OneMinusDstAlpha

enumerator SrcColor

enumerator OneMinusSrcColor

enumerator DstColor

enumerator OneMinusDstColor

enumerator ConstColor

enumerator OneMinusConstColor

enumerator ConstAlpha

enumerator OneMinusConstAlpha

enumerator AlphaSaturate

enum class ECullMode : uint8_t

Specifies the culling mode.

Values:

enumerator Disabled

enumerator FrontFacing

enumerator BackFacing

enumerator FrontAndBackFacing

enum class EDepthWrite : uint8_t

Specifies the depth write state.

Values:

enumerator Disabled

enumerator Enabled

enum class EScissorTest : uint8_t

Specifies the scissor test state.

Values:

enumerator Disabled

enumerator Enabled

enum class EDepthFunc : uint8_t

Specifies the depth function.

Values:

enumerator Disabled

enumerator Greater

enumerator GreaterEqual

enumerator Less

enumerator LessEqual

enumerator Equal

enumerator NotEqual

enumerator Always

enumerator Never

enum class EStencilFunc : uint8_t

Specifies the stencil function.

Values:

enumerator Disabled

enumerator Never

enumerator Always

enumerator Equal

enumerator NotEqual

enumerator Less

enumerator LessEqual

enumerator Greater

enumerator GreaterEqual

enum class EStencilOperation : uint8_t

Specifies the stencil operation.

Values:

enumerator Keep

enumerator Zero

enumerator Replace

enumerator Increment

enumerator IncrementWrap

enumerator Decrement

enumerator DecrementWrap

enumerator Invert

enum class EDrawMode : uint8_t

Specifies the drawing mode.

Values:

enumerator Points

enumerator Lines

enumerator LineLoop

enumerator Triangles

enumerator TriangleStrip

enumerator TriangleFan

enumerator LineStrip

enum class ERotationType : uint8_t

Specifies the rotation convention used in calculation of transforms in a right-handed coordinate system. The order of the letters in each enum value represents the order in extrinsic notation. Extrinsic convention means a rotation around any ordered set of axes ABC is done in the specified order around the original world axes which are fixed. So the object gets rotated around world original axis A, then the result is rotated around world original axis B, then the result of both is rotated around world original axis C. This is opposite to intrinsic notation, where each axis of rotation gets affected by the rotations applied to preceding axes in the rotation order, i.e., the rotation axes get rotated with objects’ rotation around every axis, e.g., rotation around axes ABC would result in rotation around world original axis A, then rotation around axis B from the object’s perspective according to its orientation from the applied rotation around axis A, then rotation around axis C from the object’s perspective according to its orientation as result of applied rotations axes around A and B.

Extrinsic rotation conventions also mean that the order of axes specified is the inverse order of applying rotation matrix multiplication. For example Euler_ZYX means the rotation matrix will be of the shape Rx * Ry * Rz * v where v is a vector or another matrix and R are right-handed rotation matrices which rotate around an axis specified by the rotation order. Check the specific enum documentation for the exact rotation order in terms of ‘which rotation is applied first’.

Values:

enumerator Euler_XYZ: rotates around X then Y then Z axis in world coordinate system

enumerator Euler_XZY: rotates around X then Z then Y axis in world coordinate system

enumerator Euler_YXZ: rotates around Y then X then Z axis in world coordinate system

enumerator Euler_YZX: rotates around Y then Z then X axis in world coordinate system

enumerator Euler_ZXY: rotates around Z then X then Y axis in world coordinate system

enumerator Euler_ZYX: rotates around Z then Y then X axis in world coordinate system

enumerator Euler_XYX: rotates around X then Y then X axis in world coordinate system

enumerator Euler_XZX: rotates around X then Z then X axis in world coordinate system

enumerator Euler_YXY: rotates around Y then X then Y axis in world coordinate system

enumerator Euler_YZY: rotates around Y then Z then Y axis in world coordinate system

enumerator Euler_ZXZ: rotates around Z then X then Z axis in world coordinate system

enumerator Euler_ZYZ: rotates around Z then Y then Z axis in world coordinate system

enumerator Quaternion: rotation is defined by a normalized quaternion

enum class EScenePublicationMode

Specifies the mode of scene publication.

When using localOnly publication it is possible to render the scene locally without calling ramses::RamsesFramework::connect.

Values:

enumerator LocalAndRemote

enumerator LocalOnly

enum class EVisibilityMode : int8_t

Specifies the mode of node visibility.

Values:

enumerator Off: A node shall be invisible and the node shall not trigger its resources to be loaded.

enumerator Invisible: A node shall be invisible, but the node shall trigger its resources to be loaded.

enumerator Visible: A node shall be fully loaded and visible.

enum class ERamsesObjectType

RamsesObject type ID.

Values:

enumerator Invalid

enumerator ClientObject

enumerator RamsesObject

enumerator SceneObject

enumerator Client

enumerator Scene

enumerator LogicEngine

enumerator LogicObject

enumerator Node

enumerator MeshNode

enumerator Camera

enumerator PerspectiveCamera

enumerator OrthographicCamera

enumerator Effect

enumerator Appearance

enumerator Geometry

enumerator PickableObject

enumerator Resource

enumerator Texture2D

enumerator Texture3D

enumerator TextureCube

enumerator ArrayResource

enumerator RenderGroup

enumerator RenderPass

enumerator BlitPass

enumerator TextureSampler

enumerator TextureSamplerMS

enumerator RenderBuffer

enumerator RenderTarget

enumerator ArrayBuffer

enumerator Texture2DBuffer

enumerator DataObject

enumerator SceneReference

enumerator TextureSamplerExternal

enum class ETextureSamplingMethod : uint8_t

Texture sampling method.

Values:

enumerator Nearest

enumerator Linear

enumerator Nearest_MipMapNearest

enumerator Nearest_MipMapLinear

enumerator Linear_MipMapNearest

enumerator Linear_MipMapLinear

enum class ETextureAddressMode : uint8_t

Texture address mode.

Values:

enumerator Clamp

enumerator Repeat

enumerator Mirror

enum class ETextureFormat : uint8_t

Texture data format.

Values:

enumerator R8

enumerator RG8

enumerator RGB8

enumerator RGB565

enumerator RGBA8

enumerator RGBA4

enumerator RGBA5551

enumerator ETC2RGB

enumerator ETC2RGBA

enumerator R16F

enumerator R32F

enumerator RG16F

enumerator RG32F

enumerator RGB16F

enumerator RGB32F

enumerator RGBA16F

enumerator RGBA32F

enumerator SRGB8

enumerator SRGB8_ALPHA8

enumerator ASTC_RGBA_4x4

enumerator ASTC_RGBA_5x4

enumerator ASTC_RGBA_5x5

enumerator ASTC_RGBA_6x5

enumerator ASTC_RGBA_6x6

enumerator ASTC_RGBA_8x5

enumerator ASTC_RGBA_8x6

enumerator ASTC_RGBA_8x8

enumerator ASTC_RGBA_10x5

enumerator ASTC_RGBA_10x6

enumerator ASTC_RGBA_10x8

enumerator ASTC_RGBA_10x10

enumerator ASTC_RGBA_12x10

enumerator ASTC_RGBA_12x12

enumerator ASTC_SRGBA_4x4

enumerator ASTC_SRGBA_5x4

enumerator ASTC_SRGBA_5x5

enumerator ASTC_SRGBA_6x5

enumerator ASTC_SRGBA_6x6

enumerator ASTC_SRGBA_8x5

enumerator ASTC_SRGBA_8x6

enumerator ASTC_SRGBA_8x8

enumerator ASTC_SRGBA_10x5

enumerator ASTC_SRGBA_10x6

enumerator ASTC_SRGBA_10x8

enumerator ASTC_SRGBA_10x10

enumerator ASTC_SRGBA_12x10

enumerator ASTC_SRGBA_12x12

enum class ETextureCubeFace

Cube texture face identifier.

Values:

enumerator PositiveX

enumerator NegativeX

enumerator PositiveY

enumerator NegativeY

enumerator PositiveZ

enumerator NegativeZ

enum class ERenderTargetDepthBufferType

Enum for type of depth buffer created within a RenderTarget.

Values:

enumerator None

enumerator Depth

enumerator DepthStencil

enum class ERenderBufferFormat

Enum for format of a RenderBuffer.

Values:

enumerator RGBA4

enumerator R8

enumerator RG8

enumerator RGB8

enumerator RGBA8

enumerator R16F

enumerator R32F

enumerator RG16F

enumerator RG32F

enumerator RGB16F

enumerator RGB32F

enumerator RGBA16F

enumerator RGBA32F

enumerator Depth16

enumerator Depth24

enumerator Depth32

enumerator Depth24_Stencil8

enum class ETextureChannelColor : uint8_t

Enum for color of texture channel.

Values:

enumerator Red

enumerator Green

enumerator Blue

enumerator Alpha

enumerator One

enumerator Zero

enum class ERenderBufferAccessMode

Enum for access mode of a RenderBuffer.

Values:

enumerator WriteOnly: RenderBuffer with this access can only be used in RenderTarget.

enumerator ReadWrite: RenderBuffer with this access can be used both in RenderTarget and TextureSampler.

using MipLevelData = std::vector<std::byte>

Texel data of one mip level of a texture.

NOTE: the texel data is stored according to OpenGL convention (first byte is from the bottom texel row). See docs of glTexImage2D for more info.

const char *toString(EBlendOperation blendOperation)

Returns string representation for blend operation.

Useful for logging, etc.

Parameters:: blendOperation – The enum parameter for which you will get the string
Returns:: String representation of the blend operation

const char *toString(EBlendFactor blendFactor)

Returns string representation for blend factor.

Useful for logging, etc.

Parameters:: blendFactor – The enum parameter for which you will get the string
Returns:: String representation of the blend factor

const char *toString(ECullMode cullMode)

Returns string representation for cull mode.

Useful for logging, etc.

Parameters:: cullMode – The enum parameter for which you will get the string
Returns:: String representation of the cull mode

const char *toString(EDepthWrite depthWrite)

Returns string representation for depth write.

Useful for logging, etc.

Parameters:: depthWrite – The enum parameter for which you will get the string
Returns:: String representation of the depth write

const char *toString(EScissorTest scissorTest)

Returns string representation for scissor test.

Useful for logging, etc.

Parameters:: scissorTest – The enum parameter for which you will get the string
Returns:: String representation of the scissor test

const char *toString(EDepthFunc depthFunc)

Returns string representation for depth function.

Useful for logging, etc.

Parameters:: depthFunc – The enum parameter for which you will get the string
Returns:: String representation of the depth function

const char *toString(EStencilFunc stencilFunc)

Returns string representation for stencil function.

Useful for logging, etc.

Parameters:: stencilFunc – The enum parameter for which you will get the string
Returns:: String representation of the stencil function

const char *toString(EStencilOperation stencilOp)

Returns string representation for stencil operation.

Useful for logging, etc.

Parameters:: stencilOp – The enum parameter for which you will get the string
Returns:: String representation of the stencil operation

const char *toString(EDrawMode drawMode)

Returns string representation for draw mode.

Useful for logging, etc.

Parameters:: drawMode – The enum parameter for which you will get the string
Returns:: String representation of the draw mode

const char *toString(ETextureSamplingMethod samplingMethod)

Returns string representation for sampling method.

Useful for logging, etc.

Parameters:: samplingMethod – The enum parameter for which you will get the string
Returns:: String representation of the sampling method

const char *toString(ETextureAddressMode addressMode)

Returns string representation for address mode.

Useful for logging, etc.

Parameters:: addressMode – The enum parameter for which you will get the string
Returns:: String representation of the address mode

const char *toString(ETextureFormat format)

Returns string representation for texture format.

Useful for logging, etc.

Parameters:: format – The enum parameter for which you will get the string
Returns:: String representation of the texture format

const char *toString(ETextureCubeFace face)

Returns string representation for texture’s cube face.

Useful for logging, etc.

Parameters:: face – The enum parameter for which you will get the string
Returns:: String representation of the cube face

inline bool FormatSupportsMipChainGeneration(ETextureFormat format)

Returns if given texture format supports mipmap chain generation

Parameters:: format – the format in question
Returns:: true if given format supports generation of mipchain

class Appearance : public ramses::SceneObject 

#include <Appearance.h>

The Appearance describes how an object should look like. This includes GLSL uniform values, and GPU states such as blending, buffer configurations, masks etc. The API to set uniform values is aligned to the glUniformX API of OpenGL. Beware that boolean values are reported and handled as int (0 is false, anything else is true) - similar to OpenGL conventions.

Public Functions

bool setBlendingFactors(EBlendFactor srcColor, EBlendFactor destColor, EBlendFactor srcAlpha, EBlendFactor destAlpha)

Sets blending factors for source/destination color/alpha. Blending operations need to be set as well in order to enable blending (see ramses::Appearance::setBlendingOperations()).

Parameters:

srcColor – [in] Source color blending factor, default: ramses::EBlendFactor::SrcAlpha
destColor – [in] Destination color blending factor, default: ramses::EBlendFactor::OneMinusSrcAlpha
srcAlpha – [in] Source alpha blending factor, default: ramses::EBlendFactor::One
destAlpha – [in] Destination alpha blending factor, default: ramses::EBlendFactor::One

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getBlendingFactors(EBlendFactor &srcColor, EBlendFactor &destColor, EBlendFactor &srcAlpha, EBlendFactor &destAlpha) const

Gets blending factors for source/destination color/alpha.

Parameters:

srcColor – [out] Source color blending factor
destColor – [out] Destination color blending factor
srcAlpha – [out] Source alpha blending factor
destAlpha – [out] Destination alpha blending factor

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setBlendingOperations(EBlendOperation operationColor, EBlendOperation operationAlpha)

Sets blending operation for color and alpha. To use blending also set the correct blending factors (see ramses::Appearance::setBlendingFactors()). Blending operations are disabled by default.

Parameters:

operationColor – [in] Blending operation for color, default: ramses::EBlendOperation::Disabled
operationAlpha – [in] Blending operation for alpha, default: ramses::EBlendOperation::Disabled

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getBlendingOperations(EBlendOperation &operationColor, EBlendOperation &operationAlpha) const

Gets blending operation for color and alpha.

Parameters:

operationColor – [out] Blending operation for color
operationAlpha – [out] Blending operation for alpha

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setBlendingColor(const vec4f &color)

Sets blending color that can be used as blending color constant for some blending factors. The default value is (0,0,0,0)

Parameters:: color – [in] RGBA channels of blending color to set ([0;1] range)
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getBlendingColor(vec4f &color) const

Gets blending color set via setBlendingColor.

Parameters:: color – [out] RGBA channels of blending color ([0;1] range)
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setDepthWrite(EDepthWrite mode)

Enables or disables writing to depth buffer. The default value is ramses::EDepthWrite::Enabled.

Parameters:: mode – [in] Flag denoting enabling or disabling depth writes.
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getDepthWriteMode(EDepthWrite &mode) const

Gets the current state of writing to depth buffer.

Parameters:: mode – [out] Depth write mode
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setDepthFunction(EDepthFunc func)

Sets depth comparison function. Default depth comparison function is ramses::EDepthFunc::LessEqual.

Parameters:: func – [in] Depth comparison function to be used
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getDepthFunction(EDepthFunc &func) const

Gets depth comparison function.

Parameters:: func – [out] Depth comparison function to be used
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setScissorTest(EScissorTest state, int16_t x, int16_t y, uint16_t width, uint16_t height)

Enables or disables scissor test and sets region for scissor test Scissor test is disabled by default (ramses::EScissorTest::Disabled)

Parameters:

state – [in] Flag denoting enabling or disabling scissor test.
x – [in] Offset of scissor region on x-axis.
y – [in] Offset of scissor region on y-axis.
width – [in] Width of scissor region.
height – [in] Height of scissor region.

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getScissorTestState(EScissorTest &state) const

Gets the current state of scissor test.

Parameters:: state – [out] State of scissor test
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getScissorRegion(int16_t &x, int16_t &y, uint16_t &width, uint16_t &height) const

Gets region for scissor test.

Parameters:

x – [out] Offset of scissor region on x-axis.
y – [out] Offset of scissor region on y-axis.
width – [out] Width of scissor region.
height – [out] Height of scissor region.

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setStencilFunction(EStencilFunc func, uint8_t ref, uint8_t mask)

Sets stencil function, reference and mask value for stencil testing. Stencil test is disabled by default.

Parameters:

func – [in] Stencil function to be used, default: ramses::EStencilFunc::Disabled
ref – [in] Stencil reference value to be used, default: 0
mask – [in] Stencil mask value to be used, default: 0xff

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getStencilFunction(EStencilFunc &func, uint8_t &ref, uint8_t &mask) const

Gets stencil function, reference and mask value.

Parameters:

func – [out] Stencil function currently set
ref – [out] Stencil reference value currently set
mask – [out] Stencil mask value currently set

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setStencilOperation(EStencilOperation sfail, EStencilOperation dpfail, EStencilOperation dppass)

Sets stencil operations for stencil testing. Default stencil operation values are ramses::EStencilOperation::Keep.

Parameters:

sfail – [in] Stencil operation when stencil test fails
dpfail – [in] Stencil operation when the stencil test passes, but the depth test fails
dppass – [in] Stencil operation when both the stencil test and the depth test pass

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getStencilOperation(EStencilOperation &sfail, EStencilOperation &dpfail, EStencilOperation &dppass) const

Gets stencil operations.

Parameters:

sfail – [out] Stencil operation when stencil test fails
dpfail – [out] Stencil operation when the stencil test passes, but the depth test fails
dppass – [out] Stencil operation when both the stencil test and the depth test pass

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setCullingMode(ECullMode mode)

Sets the culling mode indicating which side of mesh will be removed before rasterization. Default culling mode is ramses::ECullMode::BackFacing.

Parameters:: mode – [in] Culling mode to be used.
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setDrawMode(EDrawMode mode)

Sets the draw mode indicating by which primitive the mesh will be rendered Default draw mode is ramses::EDrawMode::Triangles, however if the effect used has a geometry shader, then the input type declared in the geometry shader is set as draw mode automatically when Appearance is created.

Parameters:: mode – [in] Draw mode to be used.
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getCullingMode(ECullMode &mode) const

Gets the culling mode indicating which side of mesh will be removed before rasterization.

Parameters:: mode – [out] Culling mode to be used.
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getDrawMode(EDrawMode &mode) const

Gets the draw mode indicating by which primitive the mesh will be rendered.

Parameters:: mode – [out] draw mode to be used.
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setColorWriteMask(bool writeRed, bool writeGreen, bool writeBlue, bool writeAlpha)

Sets color write mask. If needed certain color channels can stay untouched using the color write mask. By default writing to all color channels is enabled.

Parameters:

writeRed – [in] Enable/disable flag for red channel
writeGreen – [in] Enable/disable flag for green channel
writeBlue – [in] Enable/disable flag for blue channel
writeAlpha – [in] Enable/disable flag for alpha channel

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getColorWriteMask(bool &writeRed, bool &writeGreen, bool &writeBlue, bool &writeAlpha) const

Gets color write mask.

Parameters:

writeRed – [out] Enable/disable flag for red channel
writeGreen – [out] Enable/disable flag for green channel
writeBlue – [out] Enable/disable flag for blue channel
writeAlpha – [out] Enable/disable flag for alpha channel

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

template<typename T> bool setInputValue(const UniformInput &input, T &&value)

Sets value to uniform input. Value type must pass ramses::IsUniformInputDataType. This method will fail if value type not compatible with the uniform data type (see ramses::UniformInput::getDataType).

Parameters:

input – [in] The effect uniform input to set the value to
value – [in] The value to set

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

template<typename T> bool setInputValue(const UniformInput &input, size_t elementCount, const T *values)

Sets value(s) to uniform input. Value type must pass ramses::IsUniformInputDataType. This method will fail if value type not compatible with the uniform data type (see ramses::UniformInput::getDataType).

Parameters:

input – [in] The effect uniform input to set the value to
elementCount – [in] The number of elements to use from values. Must match ramses::UniformInput::getElementCount.
values – [in] Pointer the the values, must contain at least elementCount elements.

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

template<typename T> bool getInputValue(const UniformInput &input, T &value) const

Gets value of uniform input. Value type must pass ramses::IsUniformInputDataType. This method will fail if value type not compatible with the uniform data type (see ramses::UniformInput::getDataType).

Parameters:

input – [in] The effect uniform input
value – [out] The value

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

template<typename T> bool getInputValue(const UniformInput &input, size_t elementCount, T *valuesOut) const

Gets value(s) of uniform input. Value type must pass ramses::IsUniformInputDataType. This method will fail if value type not compatible with the uniform data type (see ramses::UniformInput::getDataType).

Parameters:

input – [in] The effect uniform input
elementCount – [in] The number of elements to copy to valuesOut. Must match ramses::UniformInput::getElementCount.
valuesOut – [out] location where the values are copied to

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setInputTexture(const UniformInput &input, const TextureSampler &textureSampler)

Sets texture sampler to the input.

Parameters:

input – [in] The effect uniform input to set the value to
textureSampler – [in] The texture sampler

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setInputTexture(const UniformInput &input, const TextureSamplerMS &textureSampler)

Sets multisampled texture sampler to the input.

Parameters:

input – [in] The multisampled texture sampler uniform input to set the value to
textureSampler – [in] The multisampled texture sampler

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setInputTexture(const UniformInput &input, const TextureSamplerExternal &textureSampler)

Sets external texture sampler to the input.

Parameters:

input – [in] The external texture sampler uniform input to set the value to
textureSampler – [in] The external texture sampler

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getInputTexture(const UniformInput &input, const TextureSampler *&textureSampler) const

Gets texture sampler currently set to the input.

Parameters:

input – [in] The effect uniform input
textureSampler – [out] Will set texture sampler pointer to the TextureSampler object set to the uniform input, nullptr if none set or there was an error

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getInputTextureMS(const UniformInput &input, const TextureSamplerMS *&textureSampler) const

Gets texture sampler currently set to the input.

Parameters:

input – [in] The effect uniform input
textureSampler – [out] Will set texture sampler pointer to the TextureSamplerMS object set to the uniform input, nullptr if none set or there was an error

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool getInputTextureExternal(const UniformInput &input, const TextureSamplerExternal *&textureSampler) const

Gets texture sampler currently set to the input.

Parameters:

input – [in] The effect uniform input
textureSampler – [out] Will set texture sampler pointer to the TextureSamplerExternal object set to the uniform input, nullptr if none set or there was an error

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool bindInput(const UniformInput &input, const DataObject &dataObject)

Bind a DataObject to the Appearance’s uniform input. The value from the DataObject will be used and any change made on the DataObject will be reflected in the Appearance. One DataObject can be bound to multiple Appearances. The data type of the DataObject must match the uniform input data type otherwise the call will fail and report error. DataObject cannot be bound to an input with semantics, texture input or array input. Once a DataObject is bound to an input the value cannot be set or get using set/getInputValue*() anymore. Binding a DataObject to an already bound input will unbind the old one and bind the new one.

Parameters:

input – [in] The effect uniform input to bind the DataObject to
dataObject – [in] The DataObject to be bound

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool unbindInput(const UniformInput &input)

Unbind a previously bound DataObject from the Appearance’s uniform input. Any previously set value that was set before binding will now be used. Appropriate set/getInputValue*() method must be used to set or get the value or another DataObject can be bound.

Parameters:: input – [in] The effect uniform input to unbind the DataObject from
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool isInputBound(const UniformInput &input) const

Check whether a uniform input has any DataObject bound to it.

Parameters:: input – [in] The effect uniform input to check
Returns:: true if there is any DataObject bound to the input, false otherwise

const DataObject *getDataObjectBoundToInput(const UniformInput &input) const

Gets the data object bound to a uniform input.

Parameters:: input – [in] The effect uniform input to get the bound data object for
Returns:: The data object bound the uniform input if existing, otherwise returns nullptr

const Effect &getEffect() const

Gets the effect used to create this appearance.

Returns:: The effect used to create the appearance.

internal::AppearanceImpl &impl(): Get the internal data for implementation specifics of Appearance.

const internal::AppearanceImpl &impl() const: Get the internal data for implementation specifics of Appearance.

Friends

friend class internal::SceneObjectRegistry

class ArrayBuffer : public ramses::SceneObject 

#include <ArrayBuffer.h>

The ArrayBuffer is a data object used to provide vertex or index data to ramses::Geometry::setInputBuffer and ramses::Geometry::setIndices. The buffer data of an ArrayBuffer is not filled initially and can be fully or partially updated between scene flushes.

If an ArrayBuffer object is created with type ramses::EDataType::ByteBlob then an element is defined as one byte, rather than a logical vertex element. Hence, all functions of ArrayBuffer referring to element refer to a single byte within byte array.

Public Functions

template<typename T> bool updateData(size_t firstElement, size_t numElements, const T *bufferData)

Update data of the ArrayBuffer object.

Data type of provided data must pass ramses::IsArrayResourceDataType. This method will fail if the provided data type does not match this ArrayBuffer data type (see ramses::ArrayBuffer::getDataType and ramses::GetEDataType). For ArrayBuffer objects of type ramses::EDataType::ByteBlob an element is defined as 1 byte.

Parameters:

firstElement – The element index at which data update should begin.
numElements – The number of elements to be updated. FirstElement + numElements must be less than or equal to getMaximumNumberOfElements specified at creation time of the ArrayBuffer object. The function writes (or overwrites) buffer data up to the specified count only, leaving any previously written or un-initialized data untouched.
bufferData – Pointer in memory to the data provided for update. The function makes a copy of the data into ArrayBuffer data structures. ArrayBuffer object does not take ownership of the memory data passed to it.

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

size_t getMaximumNumberOfElements() const

Returns the maximum number of data elements that can be stored in the data buffer.

For ArrayBuffer objects of type ramses::EDataType::ByteBlob this function returns the maximum size of buffer data in bytes.

Returns:: Maximum number of elements

size_t getUsedNumberOfElements() const

Returns the used number of data elements.

If data buffer fully set by updateData, then used and maximum number of elements are equal. For ArrayBuffer objects of type ramses::EDataType::ByteBlob this function returns the used size of buffer data in bytes because element is defined as byte for this type.

Returns:: Used size in number of elements

EDataType getDataType() const

Returns the data type associated with the buffer data.

Returns:: data type of buffer data

template<typename T> bool getData(T *buffer, size_t numElements) const

Copies the data of the data buffer into a user-provided buffer.

The buffer must be sufficiently large to hold the data for the numElements to be copied out. This method will fail if the provided data type does not match this ArrayBuffer data type (see ramses::ArrayBuffer::getDataType and ramses::GetEDataType). For ArrayBuffer objects of type ramses::EDataType::ByteBlob an element is defined as 1 byte.

Parameters:

buffer – [out] The buffer where the buffer data will be copied into
numElements – [in] The number of elements to copy

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

internal::ArrayBufferImpl &impl(): Get the internal data for implementation specifics of ArrayBuffer.

const internal::ArrayBufferImpl &impl() const: Get the internal data for implementation specifics of ArrayBuffer.

Friends

friend class internal::SceneObjectRegistry

class ArrayResource : public ramses::Resource 

#include <ArrayResource.h>

The ArrayResource stores a data array of a given type. The data is immutable. The resource can be used as an input for a ramses::Geometry.

If an ArrayResource object is created with type ramses::EDataType::ByteBlob then an element is defined as one byte, rather than a logical vertex element. Hence, number of elements is the same as the size in bytes.

Public Functions

size_t getNumberOfElements() const: Returns number of elements of the array.

EDataType getDataType() const: Returns the data type of the data array.

internal::ArrayResourceImpl &impl(): Get the internal data for implementation specifics of ArrayResource.

const internal::ArrayResourceImpl &impl() const: Get the internal data for implementation specifics of ArrayResource.

Friends

friend class internal::SceneObjectRegistry

class AttributeInput : public ramses::EffectInput 

#include <AttributeInput.h>

The AttributeInput is a description of an attribute effect input.

Public Functions

EEffectAttributeSemantic getSemantics() const

Returns the effect input semantics.

Returns:: Effect input semantics

~AttributeInput(): Destructor of AttributeInput.

AttributeInput(const AttributeInput &other)

Copy constructor.

Parameters:: other – source to copy from

AttributeInput(AttributeInput &&other) noexcept

Move constructor.

Parameters:: other – source to move from

AttributeInput &operator=(const AttributeInput &other)

Assignment operator.

Parameters:: other – source to assign from

AttributeInput &operator=(AttributeInput &&other) noexcept

Move assignment operator.

Parameters:: other – source to move assign from

class BlitPass : public ramses::SceneObject 

#include <BlitPass.h>

The BlitPass blits contents of one RendeBuffer to another. The source and destination RenderBuffer objects must have the same type, format and dimensions. BlitPass objects are ordered using a render order, which is also shared with RenderPass objects, i.e, BlitPass and RenderPass objects can all be ordered relative to each other.

Public Functions

const RenderBuffer &getSourceRenderBuffer() const

Get the source render buffer used for blitting.

Returns:: The source render buffer.

const RenderBuffer &getDestinationRenderBuffer() const

Get the destination render buffer used for blitting.

Returns:: The destination render buffer.

bool setBlittingRegion(uint32_t sourceX, uint32_t sourceY, uint32_t destinationX, uint32_t destinationY, uint32_t width, uint32_t height)

Set the region for blitting from source and destination render buffers. The source and destination regions must lie within the boundaries of source and destination render buffers respectively, otherwise the function fails with error status. If blitting region is not set the whole buffer is blit by default.

Parameters:

sourceX – Offset on x-axis for blitting from source render buffer
sourceY – Offset on u-axis for blitting from source render buffer
destinationX – Offset on x-axis for blitting to destination render buffer
destinationY – Offset on y-axis for blitting to destination render buffer
width – Width of blitting region, used for source and destination blitting regions
height – Height of blitting region, used for source and destination blitting regions

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

void getBlittingRegion(uint32_t &sourceX, uint32_t &sourceY, uint32_t &destinationX, uint32_t &destinationY, uint32_t &width, uint32_t &height) const

Get the blitting region in source and destination render buffers.

Parameters:

sourceX – [out] Offset on x-axis for blitting from source render buffer
sourceY – [out] Offset on y-axis for blitting from source render buffer
destinationX – [out] Offset on x-axis for blitting to destination render buffer
destinationY – [out] Offset on y-axis for blitting to destination render buffer
width – [out] Width of blitting region, used for source and destination blitting regions
height – [out] Height of blitting region, used for source and destination blitting regions

bool setRenderOrder(int32_t renderOrder)

Set the render order for the blit pass. This order defines the order in which the blit pass is executed relative to other blit and render passes. Blit and render passes with lower render order are executed first. Blit and render passes with same render order might be executed by the renderer in any order.

The default render order is Zero.

Parameters:: renderOrder – Render order used for ordering the blit pass
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

int32_t getRenderOrder() const

Get the render order of this blit pass.

Returns:: The render order of this blit pass.

bool setEnabled(bool enable)

Enable/Disable blit pass.

Parameters:: enable – The enable flag which indicates if the blit pass is rendered (Default:true)
Returns:: true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool isEnabled() const

Get the enable state of the blit pass.

Returns:: Indicates if the blit pass is enabled

internal::BlitPassImpl &impl(): Get the internal data for implementation specifics of BlitPass.

const internal::BlitPassImpl &impl() const: Get the internal data for implementation specifics of BlitPass.

Friends

friend class internal::SceneObjectRegistry

class Camera : public ramses::Node 

#include <Camera.h>

The Camera base class is part of a scene and defines a view into the scene defined by the client application. It is also a Node with transformation.

A valid camera for rendering must have a viewport and a frustum set.

Subclassed by ramses::OrthographicCamera, ramses::PerspectiveCamera

Public Functions

bool setFrustum(float leftPlane, float rightPlane, float bottomPlane, float topPlane, float nearPlane, float farPlane)

Sets camera frustum planes of the Camera.

It is mandatory to set frustum planes using either this method or ramses::PerspectiveCamera::setFrustum in order to have a valid camera for rendering.

In order to set valid frustum, all these must be true: leftPlane < rightPlane & bottomPlane < topPlane & 0 < nearPlane < farPlane.

Important note: if frustum planes data is bound (see bindFrustumPlanes) the values set here will not be effective until unbound again, bound values are always overridden by values from bound data object. Bound values can only be modified via the ramses::DataObject bound to them.

Parameters:

leftPlane – [in] Left plane of the camera frustum. Left opening angle if camera is perspective.
rightPlane – [in] Right plane of the camera frustum. Right opening angle if camera is perspective.
bottomPlane – [in] Bottom plane of the camera frustum. Bottom opening angle if camera is perspective.
topPlane – [in] Top plane of the camera frustum. Top opening angle if camera is perspective.
nearPlane – [in] Near plane of the camera frustum.
farPlane – [in] Far plane of the camera frustum.

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

bool setViewport(int32_t x, int32_t y, uint32_t width, uint32_t height)

Sets the viewport to be used when rendering with this camera.

The viewport size does not have to match the size of the destination render buffer (ramses::RenderTarget or display’s framebuffer). However when the size matches, the projected camera frustum will fill destination buffer fully. The viewport is aligned with the lower left corner of the destination render buffer.

Important note: if viewport data is bound (see bindViewportOffset or bindViewportSize) the value set here will not be effective until unbound again, bound values are always overridden by values from bound data object. Bound values can only be modified via the ramses::DataObject bound to them.

The viewport position (x and y) are relative offsets to the destination render buffer’s lower left pixel. The viewport size (width and height) must be positive numbers in the range [1, 32768].

Parameters:

x – [in] horizontal offset of the viewport rectangle in pixels (zero = leftmost pixel)
y – [in] vertical offset of the viewport rectangle in pixels (zero = bottommost pixel)
width – [in] horizontal size of the viewport rectangle in pixels (min 1, max 32768)
height – [in] vertical size of the viewport rectangle in pixels (min 1, max 32768)

Returns:

true for success, false otherwise (check log or ramses::RamsesFramework::getLastError for details).

int32_t getViewportX() const

Returns the horizontal offset of the viewport in pixels relative to lower left corner of destination render buffer.

If viewport data is bound (bindViewportOffset) the value returned here represents the effective value used, i.e. the one from bound ramses::DataObject, not the one set via setViewport.

Returns:: horizontal offset of the viewport in pixels

int32_t getViewportY() const

Returns the vertical offset of the viewport in pixels relative to lower left corner of destination render buffer.

If viewport data is bound (bindViewportOffset) the value returned here represents the effective value used, i.e. the one from bound ramses::DataObject, not the one set via setViewport.

Returns:: vertical offset of the viewport in pixels

uint32_t getViewportWidth() const

Returns the viewport width in pixels.

If viewport data is bound (bindViewportSize) the value returned here represents the effective value used, i.e. the one from bound ramses::DataObject, not the one set via setViewport.

Returns:: viewport width in pixels

uint32_t getViewportHeight() const

Returns the viewport height in pixels.

If viewport data is bound (bindViewportSize) the value returned here represents the effective value used, i.e. the one from bound ramses::DataObject, not the one set via setViewport.

Returns:: viewport height in pixels

float getLeftPlane() const

Returns the left plane of the camera frustum.