RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
ramses Namespace Reference

The RAMSES namespace contains all client side objects and functions used to implement RAMSES applications. RAMSES refers to these applications as clients. More...

Namespaces

 LayoutUtils
 
 UtfUtils
 Converts UTF and Unicode according to the Unicode standard.
 

Classes

class  AnimatedProperty
 The AnimatedProperty holds a reference to data that can be animated. More...
 
class  Animation
 The Animation combines spline with one or more AnimatedProperty instances and allows control of the animation. More...
 
class  AnimationObject
 The AnimationObject is a base class for all client API objects owned by an AnimationSystem. More...
 
class  AnimationSequence
 The AnimationSequence is a container for multiple animations. AnimationSequence has its own virtual time line where all its animations are put onto with given offsets. The sequence of animations can then be started/stopped altogether. More...
 
class  AnimationSystem
 The AnimationSystem holds all animation related data. More...
 
class  AnimationSystemObjectIterator
 The AnimationSystemObjectIterator iterates over objects of given type in an AnimationSystem. More...
 
class  AnimationSystemRealTime
 The AnimationSystemRealTime is a special version of AnimationSystem that is designed to use system time for animations. More...
 
class  Appearance
 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. More...
 
class  ArrayBuffer
 The ArrayBuffer is a data object used to provide vertex or index data to ramses::GeometryBinding::setInputBuffer and ramses::GeometryBinding::setIndices. The buffer data of an ArrayBuffer is not filled initially and can be fully or partially updated in between scene flushes. More...
 
class  ArrayResource
 The ArrayResource stores a data array of a given type. The data is immutable. The resource can be used as input for a ramses::GeometryBinding. More...
 
class  AttributeInput
 The AttributeInput is a description of an attribute effect input. More...
 
class  BlitPass
 The BlitPass blits contents of one RendeBuffer to another. The source and destination RenderBuffer objects must have same type, format and dimensions. BlitPass objects are ordered together 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. More...
 
class  Camera
 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. More...
 
class  ClientObject
 The ClientObject is a base class for all client API objects owned by a RamsesClient. More...
 
class  DataFloat
 The DataFloat data object stores a float value within a scene. More...
 
class  DataInt32
 The DataInt32 data object stores an 32-bit integer value within a scene. More...
 
class  DataMatrix22f
 The DataMatrix22f data object stores a matrix with 4 float components (2 rows, 2 columns) within a scene. More...
 
class  DataMatrix33f
 The DataMatrix33f data object stores a matrix with 9 float components (3 rows, 3 columns) within a scene. More...
 
class  DataMatrix44f
 The DataMatrix44f data object stores a matrix with 16 float components (4 rows, 4 columns) within a scene. More...
 
class  DataObject
 The DataObject is a base class for data container for storing data in a scene. More...
 
class  DataVector2f
 The DataVector2f data object stores a vector with 2 float components within a scene. More...
 
class  DataVector2i
 The DataVector2i data object stores a vector with two 32-bit-integer components within a scene. More...
 
class  DataVector3f
 The DataVector3f data object stores a vector with 3 float components within a scene. More...
 
class  DataVector3i
 The DataVector3i data object stores a vector with 3 integer components within a scene. More...
 
class  DataVector4f
 The DataVector4f data object stores a vector with 4 float components within a scene. More...
 
class  DataVector4i
 The DataVector4i data object stores a vector with 4 integer components within a scene. More...
 
class  Effect
 An effect describes how an object will be rendered to the screen. More...
 
class  EffectDescription
 An effect description holds all necessary information for an effect to be created. More...
 
class  EffectInput
 The EffectInput is a description of an effect input. More...
 
class  GeometryBinding
 A geometry binding together with an appearance describe how an object will be rendered to the screen. More...
 
class  IClientEventHandler
 Provides an interface for handling the result of client events. Implementation of this interface must be passed to RamsesClient::dispatchEvents which will in return invoke methods of the interface according to events that occurred since last dispatching. More...
 
class  MeshNode
 The MeshNode holds all information which is needed to render an object to the screen. More...
 
struct  MipLevelData
 Struct containing information about one mip-map level of a texture. More...
 
struct  CubeMipLevelData
 Struct containing information about one mip-map level of a cube texture. All faces of the cube texture must have the same size! More...
 
class  Node
 The Node is the base class of all nodes and provides scene graph functionality which propagates to its children. More...
 
class  OrthographicCamera
 The OrthographicCamera is a local camera which defines an orthographic view into the scene. More...
 
class  PerspectiveCamera
 The PerspectiveCamera is a local camera which defines a perspective view into the scene. More...
 
class  PickableObject
 PickableObject provides a way to specify a 'pickable' area. More...
 
class  RamsesClient
 Entry point of RAMSES client API. More...
 
class  RamsesObject
 The RamsesObject is a base class for all client API objects owned by the framework. More...
 
class  RenderBuffer
 RenderBuffer can be used with RenderTarget as buffer for writing or with TextureSampler as buffer for reading. More...
 
class  RenderGroup
 The RenderGroup is a container used to collect renderables which are supposed to be rendered together. Renderables added to it can be ordered within the RenderGroup so that they will be rendered in given order. RenderGroup can then be added to a RenderPass (again with optional order of RenderGroup within the RenderPass) so a hierarchical ordering of renderables can be achieved. The RenderGroup can also contain other nested RenderGroups ordered together with the renderables. If a RenderGroup with nested RenderGroups is added to a RenderPass, all renderables in all nested RenderGroups will be rendered within the RenderPass as well. The order inside a nested RenderGroup is local, i.e. all its renderables/RenderGroups are rendered before the next renderable/RenderGroup of its parent RenderGroup. More...
 
class  IteratorImpl
 
class  RenderGroupMeshIterator
 The RenderGroupMeshIterator traverses MeshNodes in a RenderGroup. More...
 
class  RenderPass
 The RenderPass is a container used to collect meshes which are supposed to be rendered together. More...
 
class  RenderPassGroupIterator
 The RenderPassGroupIterator traverses RenderGroups in a RenderPass. More...
 
class  RenderTarget
 The RenderTarget can be used as an output for a RenderPass. More...
 
class  RenderTargetDescription
 RenderTargetDescription holds all necessary information for a RenderTarget to be created. More...
 
class  Resource
 The Resource is the base class of all resources, such as arrays and textures. More...
 
class  ResourceDataPool
 The ResourceDataPool holds resource data which can be instantiated for a given scene. Resource data can either be added by calling the add functions or by attaching a resource data file to the pool. The same resource data can be instantiated by multiple scenes at the same time. More...
 
class  Scene
 The Scene holds a scene graph. It is the essential class for distributing content to the ramses system. More...
 
class  SceneConfig
 The SceneConfig holds a set of parameters to be used when creating a scene. More...
 
class  SceneGraphIterator
 A SceneObjectIterator can iterate through the nodes in the scene graph with the order specified as traversal style. More...
 
class  SceneIterator
 The SceneIterator traverses scenes in a RamsesClient. More...
 
class  SceneObject
 The SceneObject is a base class for all client API objects owned by a Scene. More...
 
class  SceneObjectIterator
 The SceneObjectIterator traverses objects in a Scene. More...
 
class  SceneReference
 The SceneReference object refers to another ramses scene using its sceneId. More...
 
class  Spline
 The Spline is a set of keys describing an animation. More...
 
class  SplineBezierFloat
 The SplineBezierFloat stores spline keys of type float that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierInt32
 The SplineBezierInt32 stores spline keys of type int32_t that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierVector2f
 The SplineBezierVector2f stores spline keys of type Vector2f that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierVector2i
 The SplineBezierVector2i stores spline keys of type Vector2i that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierVector3f
 The SplineBezierVector3f stores spline keys of type Vector3f that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierVector3i
 The SplineBezierVector3i stores spline keys of type Vector3i that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierVector4f
 The SplineBezierVector4f stores spline keys of type Vector4f that can be used for animation with Bezier interpolation. More...
 
class  SplineBezierVector4i
 The SplineBezierVector4i stores spline keys of type Vector4i that can be used for animation with Bezier interpolation. More...
 
class  SplineLinearFloat
 The SplineLinearFloat stores spline keys of type float that can be used for animation with linear interpolation. More...
 
class  SplineLinearInt32
 The SplineLinearInt32 stores spline keys of type int32_t that can be used for animation with linear interpolation. More...
 
class  SplineLinearVector2f
 The SplineLinearVector2f stores spline keys of type Vector2f that can be used for animation with linear interpolation. More...
 
class  SplineLinearVector2i
 The SplineLinearVector2i stores spline keys of type Vector2i that can be used for animation with linear interpolation. More...
 
class  SplineLinearVector3f
 The SplineLinearVector3f stores spline keys of type Vector3f that can be used for animation with linear interpolation. More...
 
class  SplineLinearVector3i
 The SplineLinearVector3i stores spline keys of type Vector3i that can be used for animation with linear interpolation. More...
 
class  SplineLinearVector4f
 The SplineLinearVector4f stores spline keys of type Vector4f that can be used for animation with linear interpolation. More...
 
class  SplineLinearVector4i
 The SplineLinearVector4i stores spline keys of type Vector4i that can be used for animation with linear interpolation. More...
 
class  SplineStepBool
 The SplineStepBool stores spline keys of type bool that can be used for animation with step interpolation. More...
 
class  SplineStepFloat
 The SplineStepFloat stores spline keys of type float that can be used for animation with step interpolation. More...
 
class  SplineStepInt32
 The SplineStepInt32 stores spline keys of type int32_t that can be used for animation with step interpolation. More...
 
class  SplineStepVector2f
 The SplineStepVector2f stores spline keys of type Vector2f that can be used for animation with step interpolation. More...
 
class  SplineStepVector2i
 The SplineStepVector2i stores spline keys of type Vector2i that can be used for animation with step interpolation. More...
 
class  SplineStepVector3f
 The SplineStepVector3f stores spline keys of type Vector3f that can be used for animation with step interpolation. More...
 
class  SplineStepVector3i
 The SplineStepVector3i stores spline keys of type Vector3i that can be used for animation with step interpolation. More...
 
class  SplineStepVector4f
 The SplineStepVector4f stores spline keys of type Vector4f that can be used for animation with step interpolation. More...
 
class  SplineStepVector4i
 The SplineStepVector4i stores spline keys of type Vector4i that can be used for animation with step interpolation. More...
 
class  StreamTexture
 StreamTexture is a special kind of texture, which holds a reference to a "fallback texture" and a stream source id. The content of the StreamTexture is dynamic and is determined within the renderer, based on whether the stream with the specified id is available or not. If it is available, the content of the StreamTexture is taken from the stream. Otherwise, the StreamTexture is replaced by the "fallback texture". More...
 
class  Texture2D
 Texture represents a 2-D texture resource. More...
 
class  Texture2DBuffer
 The Texture2DBuffer is a mutable texture buffer used to hold texture data with the possibility to perform partial updates. This object must be initialized with data, otherwise the contents of it are not specified (garbage data or black, depending on driver behavior). The number of mipmap levels is user given value and the size of the mipchain is computed according to OpenGL specification (each further mipMap level has half the size of the previous mipMap level). Refer to documentation of glTexStorage2D for more details. More...
 
class  Texture3D
 Texture represents a texture resource. More...
 
class  TextureCube
 TextureCube stores pixel data with 6 equally sized quadratic faces. More...
 
class  TextureSampler
 The TextureSampler holds a texture and its sampling parameters. More...
 
class  TextureSamplerExternal
 The ramses::TextureSamplerExternal is used to sample from external textures data when bound to a ramses::Appearance uniform input (ramses::Appearance::setInputTexture called with ramses::TextureSamplerExternal) More...
 
class  TextureSamplerMS
 The ramses::TextureSamplerMS is used to sample multisampled data when bound to a ramses::Appearance uniform input (ramses::Appearance::setInputTexture called with ramses::TextureSamplerMS) More...
 
struct  TextureSwizzle
 Information of how color channels of a texture are reordered or set to fixed value (one, zero). For example swizzling a texture with a red triangle (R:1, G:0, B:0, A:1) to TextureSwizzle(Blue, Green, Red, Alpha) would turn the triangle blue. The resulting color channels would be: (R:0, G:0, B:1, A:1). The red input color channel was basically rerouted to the blue output color channel. The color channels can also be fully overridden with a value of 0 (ETextureChannelColor::Zero) or 1 (ETextureChannelColor::One). More...
 
class  UniformInput
 The UniformInput is a description of an uniform effect input. More...
 
class  RamsesHMIUtils
 Utility functions especially created for functions not yet designated for direct API integration. More...
 
class  RamsesUtils
 Temporary functions for convenience. All of these can be implemented on top of the RAMSES Client API, but are offered here as convenience. More...
 
struct  FontCascade
 struct to define a font cascade More...
 
struct  FontIdTag
 An empty struct to make FontId a strong type. More...
 
struct  FontInstanceIdTag
 An empty struct to make FontInstanceId a strong type. More...
 
struct  FontInstanceOffset
 A list of tuples from font instances and offsets into a string. More...
 
class  FontRegistry
 Font registry can be used to load Freetype2 fonts and create font instances (optionally with Harfbuzz). These are owned and managed by FontRegistry. More...
 
struct  GlyphIdTag
 An empty struct to make GlyphId a strong type. More...
 
struct  GlyphKey
 GlyphKey identifies a glyph with a specific font instance. More...
 
struct  GlyphMetrics
 GlyphMetrics describes a glyph's position and dimensions in the rasterized glyph bitmap space. More...
 
class  IFontAccessor
 Interface for getting font instances using font instance ids. More...
 
class  IFontInstance
 Interface for font instance that can be used to query glyph metadata and bitmaps. More...
 
class  TextCache
 Stores text data - texture atlas, meshes, glyph bitmap data. It is a cache because the content can be re-generated when necessary, e.g. when cached glyphs take up too much memory. More...
 
struct  TextLineIdTag
 An empty struct to make TextLineId a strong type. More...
 
struct  TextLine
 Groups the scene objects needed to render a text line. More...
 
struct  ExtractedUnicodePoint
 Stores an extracted Unicode/UTF32 code-point and corresponding meta-data resulting from the conversion to Unicode (see also UtfUtils) More...
 
struct  CarModelViewMetadata
 Struct containing metadata about car model views. More...
 
struct  CarModelViewMetadataExtended
 Struct containing extended metadata about car model views It's an extension for CarModelViewMetadata. More...
 
class  CategoryInfoUpdate
 Update of information about a DCSM category. Contains information like changes in size. Objects of this type will be provided by ramses callbacks and are used to give information on consumer side. Do not reuse objects on consumer side, since they track changes and would transmit these again if reused. More...
 
struct  ContentIDTag
 Unique type tag for ContentID. More...
 
struct  CategoryTag
 Unique type tag for Category. More...
 
struct  TechnicalContentDescriptorTag
 Unique type tag for TechnicalContentDescriptor. More...
 
struct  Rect
 Rectangle consisting of x, y, width, height. More...
 
struct  SizeInfo
 Size information for DCSM canvas size change. More...
 
struct  AnimationInformation
 
class  DcsmConsumer
 Class representing DCSM consumer side. More...
 
class  DcsmMetadataCreator
 Class to create DCSM metadata object to be used in DcsmProvider. More...
 
class  DcsmMetadataUpdate
 Class to extract DCSM metadata entries from. Objects of this type will be provided by ramses callbacks and should not be created directly. More...
 
class  DcsmProvider
 Class used to offer ramses content and meta infos to a consumer and synchronize actions between client and renderer side applications. More...
 
class  DcsmStatusMessage
 The base class of a message to be sent from DCSM consumer to provider. More...
 
class  StreamStatusMessage
 A message containing a stream status. More...
 
class  ActiveLayoutMessage
 A status message containing the instrument cluster's active layout. More...
 
class  WidgetFocusStatusMessage
 A message containing the widget focus state. More...
 
class  IDcsmConsumerEventHandler
 Callback interface for received DCSM consumer side events. Used with DcsmConsumer::dispatchEvents(). More...
 
class  IDcsmProviderEventHandler
 An Interface for a class, whose functions are called as reaction to DcsmConsumer communication after calling dispatchEvents() on a DcsmProvider object. More...
 
class  IDcsmProviderEventHandlerExtended
 An Interface for a class, whose functions are called as reaction to a DcsmConsumer message after calling dispatchEventsAndMessage() on a DcsmProvider object. More...
 
class  IRamshCommand
 Class representing a ramses ramsh command. More...
 
class  IThreadWatchdogNotification
 
class  RamsesFramework
 Class representing ramses framework components that are needed to initialize an instance of ramses client and renderer. More...
 
class  RamsesFrameworkConfig
 The RamsesFrameworkConfig holds a set of parameters to be used to initialize ramses. More...
 
struct  SceneIdTag
 Struct used as unique id for the strongly typed scene id. More...
 
struct  resourceId_t
 Resource identifier used to refer to a resource. More...
 
struct  nodeIdTag
 Struct used as unique id for the strongly typed node Id. More...
 
struct  resourceCacheFlagTag
 Struct used as unique id for the strongly-typed cache flag. More...
 
struct  pickableObjectTag
 Dummy struct to uniquely define ramses::pickableObjectId_t. More...
 
struct  sceneObjectTag
 Dummy struct to uniquely define ramses::sceneObjectId_t. More...
 
struct  waylandIviSurfaceIdTag
 Struct used as unique id for the strongly typed Wayland IVI Surface Id. More...
 
struct  waylandIviLayerIdTag
 Struct used as unique id for the strongly typed Wayland IVI Layer Id. More...
 
struct  RamsesVersion
 Ramses version information. More...
 
class  StatusObject
 The StatusObject provides status message handling. More...
 
class  StronglyTypedValue
 Helper class to create strongly typed values out of various types. More...
 
class  BinaryShaderCache
 Provide default implementation for IBinaryShaderCache interface, to be used in RamsesRenderer by setting in RendererConfig. Also provides functions to serialize binary shaders to file and deserialize binary shaders from file. More...
 
class  DcsmContentControl
 DcsmContentControl provides way to interact with both Dcsm (as consumer) and renderer content control (replaces ramses::RendererSceneControl). More...
 
class  DefaultRendererResourceCache
 The DefaultRendererResourceCache provides a simple example on how the IRendererResourceCache interface can be implemented. It is only intended as an example, as the optimal implementation would be very specific to how RAMSES is being utilized. More...
 
class  DisplayConfig
 The DisplayConfig holds a set of parameters to be used to initialize a display. More...
 
class  IBinaryShaderCache
 An interface used to exchange Binary Shader Cache with the RamsesRenderer. The RamsesRenderer will not delete this class, it is owned by the application. More...
 
class  IDcsmContentControlEventHandler
 Callback handler interface for events emitted by ramses::DcsmContentControl. More...
 
class  DcsmContentControlEventHandlerEmpty
 Convenience empty implementation of IDcsmContentControlEventHandler that can be used to derive from when only subset of event handling methods need to be implemented. More...
 
class  IRendererEventHandler
 Provides an interface for handling the result of renderer events. Implementation of this interface must be passed to RamsesRenderer::dispatchEvents which will in return invoke methods of the interface according to events that occurred since last dispatching. More...
 
class  RendererEventHandlerEmpty
 Convenience empty implementation of IRendererEventHandler that can be used to derive from when only subset of event handling methods need to be implemented. More...
 
class  IRendererResourceCache
 An interface used to implement a caching mechanism for resources used on the RamsesRenderer. Important: Please note that the resource ids in this context do not match client resource ids. More...
 
class  IRendererSceneControlEventHandler
 Provides an interface for handling the result of renderer scene control events. Implementation of this interface must be passed to ramses::RendererSceneControl::dispatchEvents which will in return invoke methods of the interface according to events that occurred since last dispatching. More...
 
class  RendererSceneControlEventHandlerEmpty
 Convenience empty implementation of IRendererSceneControlEventHandler that can be used to derive from when only subset of event handling methods need to be implemented. More...
 
class  RamsesRenderer
 RamsesRenderer is the main renderer component which provides API to configure and control the way content will be rendered on display(s). More...
 
class  RendererConfig
 The RendererConfig holds a set of parameters to be used to initialize a renderer. More...
 
class  RendererSceneControl
 Control states of scenes. More...
 
struct  rendererResourceId_t
 Resource identifier used to refer to a resource on the renderer. More...
 
class  WarpingMeshData
 The WarpingMeshData holds the vertices and indices needed to create the mesh for display warping. More...
 

Typedefs

using timeMilliseconds_t = int64_t
 
using globalTimeStamp_t = uint64_t
 
using splineTimeStamp_t = uint32_t
 
using sequenceTimeStamp_t = uint32_t
 
using splineKeyIndex_t = uint32_t
 
using OrderedFontList = std::vector< FontInstanceId >
 vector of FontInstanceId for use in FontCascade More...
 
using FontId = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), FontIdTag >
 A strongly typed integer to distinguish between different fonts. More...
 
using FontInstanceId = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), FontInstanceIdTag >
 A strongly typed integer to distinguish between different font instances. More...
 
using FontInstanceOffsets = std::vector< FontInstanceOffset >
 Vector of FontInstanceOffset elements. More...
 
using GlyphData = std::vector< uint8_t >
 Stores 2-dimensional glyph pixel data as a flat memory array. More...
 
using GlyphId = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), GlyphIdTag >
 A strongly typed integer to distinguish between different glyphs. More...
 
using GlyphKeyVector = std::vector< GlyphKey >
 Vector of GlyphKey elements. More...
 
using GlyphMetricsVector = std::vector< GlyphMetrics >
 Vector of GlyphMetrics elements. More...
 
using TextLineId = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), TextLineIdTag >
 A strongly typed integer to distinguish between different text lines. More...
 
using ContentID = StronglyTypedValue< uint64_t, 0, ContentIDTag >
 Identifier for DCSM content. Must be globally unique. More...
 
using Category = StronglyTypedValue< uint64_t, 0, CategoryTag >
 Category descriptor for DCSM. More...
 
using TechnicalContentDescriptor = StronglyTypedValue< uint64_t, 0, TechnicalContentDescriptorTag >
 Distribution specific descriptor for DCSM content. It allows bindings content IDs to specific distribution mechanism, e.g. ramses scenes via sceneId_t. More...
 
using status_t = uint32_t
 Status is a handle to the result of an API call. More...
 
using sceneId_t = StronglyTypedValue< uint64_t, 0, struct SceneIdTag >
 Scene identifier used to refer to scenes created using client API and then manage their mapping using renderer API. More...
 
using sceneVersionTag_t = uint64_t
 Scene version tag used to refer to content versions of a scene. A scene version may be updated along with a scene transaction. More...
 
using displayId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), struct DisplayIdTag >
 Display identifier used to refer to display in renderer API and dispatched callbacks. More...
 
using displayBufferId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), struct DisplayBufferIdTag >
 Display buffer identifier referring to either a display's framebuffer or a created offscreen buffer. More...
 
using streamBufferId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), struct StreamBufferIdTag >
 Stream buffer identifier referring to Wayland stream. More...
 
using externalBufferId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), struct ExternalBufferIdTag >
 External buffer identifier referring to external buffer. More...
 
using dataProviderId_t = StronglyTypedValue< uint32_t, 0, struct DataProviderIdTag >
 Data identifier used to refer to data provider and then manage their linkage to data consumer using renderer API. More...
 
using dataConsumerId_t = StronglyTypedValue< uint32_t, 0, struct DataConsumerIdTag >
 Data link identifier used to refer to data consumer and then manage their linkage to data provider using renderer API. More...
 
using nodeId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), nodeIdTag >
 Node identifier used to refer to a node. More...
 
using LogHandlerFunc = std::function< void(ELogLevel, const std::string &, const std::string &)>
 
using resourceCacheFlag_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), resourceCacheFlagTag >
 Cache flag value used for passing a strong-typed flag value to a renderer. More...
 
using pickableObjectId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), pickableObjectTag >
 User ID of a pickable object to be provided when creating ramses::PickableObject. More...
 
using binaryShaderFormatId_t = StronglyTypedValue< uint32_t, 0, struct binaryShaderFormatIdTag >
 Binary shader format identifier used in ramses::IBinaryShaderCache. More...
 
using sceneObjectId_t = StronglyTypedValue< uint64_t, 0, sceneObjectTag >
 ID that is automatically given to ramses::SceneObject on creation. More...
 
using waylandIviSurfaceId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), waylandIviSurfaceIdTag >
 Id assigned to Surface in Wayland with IVI extension Also known as "ivi id". More...
 
using waylandIviLayerId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), waylandIviLayerIdTag >
 Id assigned to Layer in Wayland with IVI extension. More...
 
using effectId_t = rendererResourceId_t
 Effect identifier used by the renderer to refer to an effect. More...
 

Enumerations

enum  EAnimatedPropertyComponent {
  EAnimatedPropertyComponent_X = 0 , EAnimatedPropertyComponent_Y , EAnimatedPropertyComponent_Z , EAnimatedPropertyComponent_W ,
  EAnimatedPropertyComponent_All
}
 Vector component ID for binding single/multi component data. More...
 
enum  EAnimatedProperty { EAnimatedProperty_Translation = 0 , EAnimatedProperty_Rotation , EAnimatedProperty_Scaling }
 Property to animate for objects that have more than one property that can be animated. More...
 
enum  EAnimationSystemFlags { EAnimationSystemFlags_Default = 0 , EAnimationSystemFlags_ClientSideProcessing , EAnimationSystemFlags_SynchronizedClock }
 AnimationSystem creation flags. More...
 
enum  EInputType {
  EInputType_Invalid = 0 , EInputType_Float , EInputType_Vector2f , EInputType_Vector3f ,
  EInputType_Vector4f , EInputType_Int16 , EInputType_Int32 , EInputType_UInt16 ,
  EInputType_UInt32 , EInputType_Vector2i , EInputType_Vector3i , EInputType_Vector4i ,
  EInputType_Matrix22f , EInputType_Matrix23f , EInputType_Matrix24f , EInputType_Matrix32f ,
  EInputType_Matrix33f , EInputType_Matrix34f , EInputType_Matrix42f , EInputType_Matrix43f ,
  EInputType_Matrix44f , EInputType_TextureSampler , EInputType_AttributeUInt16 , EInputType_AttributeFloat ,
  EInputType_AttributeVector2f , EInputType_AttributeVector3f , EInputType_AttributeVector4f , EInputType_NUMBER_OF_ELEMENTS
}
 
enum  EBlendOperation {
  EBlendOperation_Disabled = 0 , EBlendOperation_Add , EBlendOperation_Subtract , EBlendOperation_ReverseSubtract ,
  EBlendOperation_Min , EBlendOperation_Max , EBlendOperation_NUMBER_OF_ELEMENTS
}
 
enum  EBlendFactor {
  EBlendFactor_Zero = 0 , EBlendFactor_One , EBlendFactor_SrcAlpha , EBlendFactor_OneMinusSrcAlpha ,
  EBlendFactor_DstAlpha , EBlendFactor_OneMinusDstAlpha , EBlendFactor_SrcColor , EBlendFactor_OneMinusSrcColor ,
  EBlendFactor_DstColor , EBlendFactor_OneMinusDstColor , EBlendFactor_ConstColor , EBlendFactor_OneMinusConstColor ,
  EBlendFactor_ConstAlpha , EBlendFactor_OneMinusConstAlpha , EBlendFactor_AlphaSaturate , EBlendFactor_NUMBER_OF_ELEMENTS
}
 
enum  ECullMode {
  ECullMode_Disabled = 0 , ECullMode_FrontFacing , ECullMode_BackFacing , ECullMode_FrontAndBackFacing ,
  ECullMode_NUMBER_OF_ELEMENTS
}
 
enum  EDepthWrite { EDepthWrite_Disabled = 0 , EDepthWrite_Enabled , EDepthWrite_NUMBER_OF_ELEMENTS }
 
enum  EScissorTest { EScissorTest_Disabled = 0 , EScissorTest_Enabled , EScissorTest_NUMBER_OF_ELEMENTS }
 
enum  EDepthFunc {
  EDepthFunc_Disabled = 0 , EDepthFunc_Greater , EDepthFunc_GreaterEqual , EDepthFunc_Less ,
  EDepthFunc_LessEqual , EDepthFunc_Equal , EDepthFunc_NotEqual , EDepthFunc_Always ,
  EDepthFunc_Never , EDepthFunc_NUMBER_OF_ELEMENTS
}
 
enum  EStencilFunc {
  EStencilFunc_Disabled = 0 , EStencilFunc_Never , EStencilFunc_Always , EStencilFunc_Equal ,
  EStencilFunc_NotEqual , EStencilFunc_Less , EStencilFunc_LessEqual , EStencilFunc_Greater ,
  EStencilFunc_GreaterEqual , EStencilFunc_NUMBER_OF_ELEMENTS
}
 
enum  EStencilOperation {
  EStencilOperation_Keep = 0 , EStencilOperation_Zero , EStencilOperation_Replace , EStencilOperation_Increment ,
  EStencilOperation_IncrementWrap , EStencilOperation_Decrement , EStencilOperation_DecrementWrap , EStencilOperation_Invert ,
  EStencilOperation_NUMBER_OF_ELEMENTS
}
 
enum  EDrawMode {
  EDrawMode_Points = 0 , EDrawMode_Lines , EDrawMode_Triangles , EDrawMode_TriangleStrip ,
  EDrawMode_LineLoop , EDrawMode_TriangleFan , EDrawMode_LineStrip , EDrawMode_NUMBER_OF_ELEMENTS
}
 
enum class  EDataType {
  UInt16 = 0 , UInt32 , Float , Vector2F ,
  Vector3F , Vector4F , ByteBlob
}
 Specifies the data type used for creating data buffers. More...
 
enum class  ERotationConvention {
  XYZ , XZY , YXZ , YZX ,
  ZXY , ZYX , XYX , XZX ,
  YXY , YZY , ZXZ , ZYZ
}
 
enum  EScenePublicationMode { EScenePublicationMode_LocalAndRemote = 0 , EScenePublicationMode_LocalOnly }
 
enum class  EVisibilityMode : uint32_t { Off = 0 , Invisible , Visible }
 
enum  EEffectInputDataType {
  EEffectInputDataType_Invalid = 0 , EEffectInputDataType_Int32 , EEffectInputDataType_UInt16 , EEffectInputDataType_UInt32 ,
  EEffectInputDataType_Float , EEffectInputDataType_Vector2F , EEffectInputDataType_Vector3F , EEffectInputDataType_Vector4F ,
  EEffectInputDataType_Vector2I , EEffectInputDataType_Vector3I , EEffectInputDataType_Vector4I , EEffectInputDataType_Matrix22F ,
  EEffectInputDataType_Matrix33F , EEffectInputDataType_Matrix44F , EEffectInputDataType_TextureSampler2D , EEffectInputDataType_TextureSampler2DMS ,
  EEffectInputDataType_TextureSampler3D , EEffectInputDataType_TextureSamplerCube , EEffectInputDataType_TextureSamplerExternal
}
 Data type of effect input. More...
 
enum class  EEffectUniformSemantic {
  Invalid = 0 , ProjectionMatrix , ModelMatrix , CameraWorldPosition ,
  ViewMatrix , ModelViewMatrix , ModelViewMatrix33 , ModelViewProjectionMatrix ,
  NormalMatrix , DisplayBufferResolution , TextTexture , TimeMs
}
 Effect uniform semantic type. More...
 
enum class  EEffectAttributeSemantic { Invalid = 0 , TextPositions , TextTextureCoordinates }
 Effect attribute semantic type. More...
 
enum  ERamsesObjectType {
  ERamsesObjectType_Invalid = 0 , ERamsesObjectType_ClientObject , ERamsesObjectType_RamsesObject , ERamsesObjectType_SceneObject ,
  ERamsesObjectType_AnimationObject , ERamsesObjectType_Client , ERamsesObjectType_Scene , ERamsesObjectType_AnimationSystem ,
  ERamsesObjectType_AnimationSystemRealTime , ERamsesObjectType_Node , ERamsesObjectType_MeshNode , ERamsesObjectType_Camera ,
  ERamsesObjectType_PerspectiveCamera , ERamsesObjectType_OrthographicCamera , ERamsesObjectType_Effect , ERamsesObjectType_AnimatedProperty ,
  ERamsesObjectType_Animation , ERamsesObjectType_AnimationSequence , ERamsesObjectType_Appearance , ERamsesObjectType_GeometryBinding ,
  ERamsesObjectType_PickableObject , ERamsesObjectType_Spline , ERamsesObjectType_SplineStepBool , ERamsesObjectType_SplineStepFloat ,
  ERamsesObjectType_SplineStepInt32 , ERamsesObjectType_SplineStepVector2f , ERamsesObjectType_SplineStepVector3f , ERamsesObjectType_SplineStepVector4f ,
  ERamsesObjectType_SplineStepVector2i , ERamsesObjectType_SplineStepVector3i , ERamsesObjectType_SplineStepVector4i , ERamsesObjectType_SplineLinearFloat ,
  ERamsesObjectType_SplineLinearInt32 , ERamsesObjectType_SplineLinearVector2f , ERamsesObjectType_SplineLinearVector3f , ERamsesObjectType_SplineLinearVector4f ,
  ERamsesObjectType_SplineLinearVector2i , ERamsesObjectType_SplineLinearVector3i , ERamsesObjectType_SplineLinearVector4i , ERamsesObjectType_SplineBezierFloat ,
  ERamsesObjectType_SplineBezierInt32 , ERamsesObjectType_SplineBezierVector2f , ERamsesObjectType_SplineBezierVector3f , ERamsesObjectType_SplineBezierVector4f ,
  ERamsesObjectType_SplineBezierVector2i , ERamsesObjectType_SplineBezierVector3i , ERamsesObjectType_SplineBezierVector4i , ERamsesObjectType_Resource ,
  ERamsesObjectType_Texture2D , ERamsesObjectType_Texture3D , ERamsesObjectType_TextureCube , ERamsesObjectType_ArrayResource ,
  ERamsesObjectType_RenderGroup , ERamsesObjectType_RenderPass , ERamsesObjectType_BlitPass , ERamsesObjectType_TextureSampler ,
  ERamsesObjectType_TextureSamplerMS , ERamsesObjectType_RenderBuffer , ERamsesObjectType_RenderTarget , ERamsesObjectType_DataBufferObject ,
  ERamsesObjectType_Texture2DBuffer , ERamsesObjectType_DataObject , ERamsesObjectType_DataFloat , ERamsesObjectType_DataVector2f ,
  ERamsesObjectType_DataVector3f , ERamsesObjectType_DataVector4f , ERamsesObjectType_DataMatrix22f , ERamsesObjectType_DataMatrix33f ,
  ERamsesObjectType_DataMatrix44f , ERamsesObjectType_DataInt32 , ERamsesObjectType_DataVector2i , ERamsesObjectType_DataVector3i ,
  ERamsesObjectType_DataVector4i , ERamsesObjectType_StreamTexture , ERamsesObjectType_SceneReference , ERamsesObjectType_TextureSamplerExternal ,
  ERamsesObjectType_NUMBER_OF_TYPES
}
 RamsesObject type ID. More...
 
enum  ETreeTraversalStyle { ETreeTraversalStyle_DepthFirst = 0 , ETreeTraversalStyle_BreadthFirst }
 Tree traversal style. More...
 
enum  ETextureSamplingMethod {
  ETextureSamplingMethod_Nearest = 0 , ETextureSamplingMethod_Linear , ETextureSamplingMethod_Nearest_MipMapNearest , ETextureSamplingMethod_Nearest_MipMapLinear ,
  ETextureSamplingMethod_Linear_MipMapNearest , ETextureSamplingMethod_Linear_MipMapLinear , ETextureSamplingMethod_NUMBER_OF_ELEMENTS
}
 Texture sampling method. More...
 
enum  ETextureAddressMode { ETextureAddressMode_Clamp = 0 , ETextureAddressMode_Repeat , ETextureAddressMode_Mirror , ETextureAddressMode_NUMBER_OF_ELEMENTS }
 Texture address mode. More...
 
enum class  ETextureFormat {
  Invalid = 0 , R8 , RG8 , RGB8 ,
  RGB565 , RGBA8 , RGBA4 , RGBA5551 ,
  ETC2RGB , ETC2RGBA , R16F , R32F ,
  RG16F , RG32F , RGB16F , RGB32F ,
  RGBA16F , RGBA32F , SRGB8 , SRGB8_ALPHA8 ,
  ASTC_RGBA_4x4 , ASTC_RGBA_5x4 , ASTC_RGBA_5x5 , ASTC_RGBA_6x5 ,
  ASTC_RGBA_6x6 , ASTC_RGBA_8x5 , ASTC_RGBA_8x6 , ASTC_RGBA_8x8 ,
  ASTC_RGBA_10x5 , ASTC_RGBA_10x6 , ASTC_RGBA_10x8 , ASTC_RGBA_10x10 ,
  ASTC_RGBA_12x10 , ASTC_RGBA_12x12 , ASTC_SRGBA_4x4 , ASTC_SRGBA_5x4 ,
  ASTC_SRGBA_5x5 , ASTC_SRGBA_6x5 , ASTC_SRGBA_6x6 , ASTC_SRGBA_8x5 ,
  ASTC_SRGBA_8x6 , ASTC_SRGBA_8x8 , ASTC_SRGBA_10x5 , ASTC_SRGBA_10x6 ,
  ASTC_SRGBA_10x8 , ASTC_SRGBA_10x10 , ASTC_SRGBA_12x10 , ASTC_SRGBA_12x12 ,
  NUMBER_OF_ELEMENTS
}
 Texture data format. More...
 
enum  ETextureCubeFace {
  ETextureCubeFace_PositiveX = 0 , ETextureCubeFace_NegativeX , ETextureCubeFace_PositiveY , ETextureCubeFace_NegativeY ,
  ETextureCubeFace_PositiveZ , ETextureCubeFace_NegativeZ , ETextureCubeFace_NUMBER_OF_ELEMENTS
}
 Cube texture face identifier. More...
 
enum  ERenderTargetDepthBufferType { ERenderTargetDepthBufferType_None = 0 , ERenderTargetDepthBufferType_Depth , ERenderTargetDepthBufferType_DepthStencil }
 Enum for type of depth buffer created within a RenderTarget. More...
 
enum  ERenderBufferType { ERenderBufferType_Color = 0 , ERenderBufferType_Depth , ERenderBufferType_DepthStencil }
 Enum for type of a RenderBuffer. More...
 
enum  ERenderBufferFormat {
  ERenderBufferFormat_RGBA4 = 0 , ERenderBufferFormat_R8 , ERenderBufferFormat_RG8 , ERenderBufferFormat_RGB8 ,
  ERenderBufferFormat_RGBA8 , ERenderBufferFormat_R16F , ERenderBufferFormat_R32F , ERenderBufferFormat_RG16F ,
  ERenderBufferFormat_RG32F , ERenderBufferFormat_RGB16F , ERenderBufferFormat_RGB32F , ERenderBufferFormat_RGBA16F ,
  ERenderBufferFormat_RGBA32F , ERenderBufferFormat_Depth24 , ERenderBufferFormat_Depth24_Stencil8
}
 Enum for format of a RenderBuffer. More...
 
enum class  ETextureChannelColor : uint8_t {
  Red , Green , Blue , Alpha ,
  One , Zero
}
 Enum for color of texture channel. More...
 
enum  ERenderBufferAccessMode { ERenderBufferAccessMode_WriteOnly = 0 , ERenderBufferAccessMode_ReadWrite }
 Enum for access mode of a RenderBuffer. More...
 
enum class  ETechnicalContentType { RamsesSceneID , WaylandIviSurfaceID }
 Enum describing the possible distribution mechanisms for a specific content. More...
 
enum class  EDcsmState { Offered , Assigned , Ready , Shown }
 DCSM content states. Used to request a specific state from provider via DcsmConsumer::sendContentStatusChange. More...
 
enum class  EDcsmOfferingMode { LocalOnly = 0 , LocalAndRemote }
 
enum  EValidationSeverity { EValidationSeverity_Info = 0 , EValidationSeverity_Warning , EValidationSeverity_Error }
 The EValidationSeverity defines severity of validation results. More...
 
enum  ERamsesThreadIdentifier { ERamsesThreadIdentifier_Unknown = 0 , ERamsesThreadIdentifier_Workers , ERamsesThreadIdentifier_Renderer }
 
enum  ERamsesShellType { ERamsesShellType_None = 0 , ERamsesShellType_Console , ERamsesShellType_Default }
 Type of Ramses Shell. More...
 
enum class  ELogLevel {
  Off , Fatal , Error , Warn ,
  Info , Debug , Trace
}
 Type of Ramses Log Level. More...
 
enum  EClearFlags {
  EClearFlags_None = 0 , EClearFlags_Color = 1 << 0 , EClearFlags_Depth = 1 << 1 , EClearFlags_Stencil = 1 << 2 ,
  EClearFlags_All = EClearFlags_Color | EClearFlags_Depth | EClearFlags_Stencil
}
 Clear flags used to specify which components of a render target or display buffer should be cleared. More...
 
enum class  RendererSceneState : uint8_t { Unavailable , Available , Ready , Rendered }
 
enum class  DcsmContentControlEventResult { OK , TimedOut }
 ramses::DcsmContentControl event result used in some event handler callbacks More...
 
enum  ESceneResourceStatus { ESceneResourceStatus_Pending = 0 , ESceneResourceStatus_Ready }
 
enum  ERendererEventResult { ERendererEventResult_OK = 0 , ERendererEventResult_INDIRECT , ERendererEventResult_FAIL }
 Specifies the result of the operation referred to by renderer event. More...
 
enum  EMouseEvent {
  EMouseEvent_Invalid = 0 , EMouseEvent_LeftButtonDown , EMouseEvent_LeftButtonUp , EMouseEvent_RightButtonDown ,
  EMouseEvent_RightButtonUp , EMouseEvent_MiddleButtonDown , EMouseEvent_MiddleButtonUp , EMouseEvent_WheelUp ,
  EMouseEvent_WheelDown , EMouseEvent_Move , EMouseEvent_WindowEnter , EMouseEvent_WindowLeave
}
 Specifies events for mouse input. More...
 
enum  EKeyEvent { EKeyEvent_Invalid = 0 , EKeyEvent_Pressed , EKeyEvent_Released }
 Specifies keypress events for keyboard input. More...
 
enum  EKeyCode {
  EKeyCode_Unknown = 0 , EKeyCode_A , EKeyCode_B , EKeyCode_C ,
  EKeyCode_D , EKeyCode_E , EKeyCode_F , EKeyCode_G ,
  EKeyCode_H , EKeyCode_I , EKeyCode_J , EKeyCode_K ,
  EKeyCode_L , EKeyCode_M , EKeyCode_N , EKeyCode_O ,
  EKeyCode_P , EKeyCode_Q , EKeyCode_R , EKeyCode_S ,
  EKeyCode_T , EKeyCode_U , EKeyCode_V , EKeyCode_W ,
  EKeyCode_X , EKeyCode_Y , EKeyCode_Z , EKeyCode_0 ,
  EKeyCode_1 , EKeyCode_2 , EKeyCode_3 , EKeyCode_4 ,
  EKeyCode_5 , EKeyCode_6 , EKeyCode_7 , EKeyCode_8 ,
  EKeyCode_9 , EKeyCode_NumLock , EKeyCode_Numpad_Add , EKeyCode_Numpad_Subtract ,
  EKeyCode_Numpad_Multiply , EKeyCode_Numpad_Divide , EKeyCode_Numpad_Enter , EKeyCode_Numpad_Decimal ,
  EKeyCode_Numpad_0 , EKeyCode_Numpad_1 , EKeyCode_Numpad_2 , EKeyCode_Numpad_3 ,
  EKeyCode_Numpad_4 , EKeyCode_Numpad_5 , EKeyCode_Numpad_6 , EKeyCode_Numpad_7 ,
  EKeyCode_Numpad_8 , EKeyCode_Numpad_9 , EKeyCode_Return , EKeyCode_Escape ,
  EKeyCode_Backspace , EKeyCode_Tab , EKeyCode_Space , EKeyCode_Menu ,
  EKeyCode_CapsLock , EKeyCode_ShiftLeft , EKeyCode_ShiftRight , EKeyCode_AltLeft ,
  EKeyCode_AltRight , EKeyCode_ControlLeft , EKeyCode_ControlRight , EKeyCode_WindowsLeft ,
  EKeyCode_WindowsRight , EKeyCode_F1 , EKeyCode_F2 , EKeyCode_F3 ,
  EKeyCode_F4 , EKeyCode_F5 , EKeyCode_F6 , EKeyCode_F7 ,
  EKeyCode_F8 , EKeyCode_F9 , EKeyCode_F10 , EKeyCode_F11 ,
  EKeyCode_F12 , EKeyCode_PrintScreen , EKeyCode_ScrollLock , EKeyCode_Pause ,
  EKeyCode_Insert , EKeyCode_Home , EKeyCode_PageUp , EKeyCode_Delete ,
  EKeyCode_End , EKeyCode_PageDown , EKeyCode_Right , EKeyCode_Left ,
  EKeyCode_Up , EKeyCode_Down , EKeyCode_Minus , EKeyCode_Equals ,
  EKeyCode_LeftBracket , EKeyCode_RightBracket , EKeyCode_Backslash , EKeyCode_Semicolon ,
  EKeyCode_Comma , EKeyCode_Period , EKeyCode_Slash , EKeyCode_Apostrophe ,
  EKeyCode_Grave , EKeyCode_NumberSign
}
 Specifies key codes for keyboard input. More...
 
enum  EKeyModifier {
  EKeyModifier_NoModifier = 0 , EKeyModifier_Ctrl = 1 << 0 , EKeyModifier_Shift = 1 << 1 , EKeyModifier_Alt = 1 << 2 ,
  EKeyModifier_Function = 1 << 3 , EKeyModifier_Numpad = 1 << 4
}
 Specifies key modifiers for keyboard input. More...
 
enum  ELoopMode { ELoopMode_UpdateAndRender = 0 , ELoopMode_UpdateOnly }
 Specifies behavior of render loop. More...
 
enum  EDepthBufferType { EDepthBufferType_None = 0 , EDepthBufferType_Depth , EDepthBufferType_DepthStencil }
 Specifies type of depth buffer created within an offscreen buffer. More...
 

Functions

RAMSES_API const char * getInputTypeString (EInputType inputType)
 Returns string representation for input type. More...
 
RAMSES_API const char * getBlendOperationString (EBlendOperation blendOperation)
 Returns string representation for blend operation. More...
 
RAMSES_API const char * getBlendFactorString (EBlendFactor blendFactor)
 Returns string representation for blend factor. More...
 
RAMSES_API const char * getCullModeString (ECullMode cullMode)
 Returns string representation for cull mode. More...
 
RAMSES_API const char * getDepthWriteString (EDepthWrite depthWrite)
 Returns string representation for depth write. More...
 
RAMSES_API const char * getScissorTestString (EScissorTest scissorTest)
 Returns string representation for scissor test. More...
 
RAMSES_API const char * getDepthFuncString (EDepthFunc depthFunc)
 Returns string representation for depth function. More...
 
RAMSES_API const char * getStencilFuncString (EStencilFunc stencilFunc)
 Returns string representation for stencil function. More...
 
RAMSES_API const char * getStencilOperationString (EStencilOperation stencilOp)
 Returns string representation for stencil operation. More...
 
RAMSES_API const char * getDrawModeString (EDrawMode drawMode)
 Returns string representation for draw mode. More...
 
constexpr size_t GetNumberOfComponents (EDataType dataType)
 Retrieve number of components per element of specified data type. More...
 
constexpr size_t GetSizeOfComponent (EDataType dataType)
 Retrieve size of one component of specified data type in bytes. More...
 
constexpr size_t GetSizeOfDataType (EDataType dataType)
 Retrieve size of one element of specified data type in bytes. More...
 
RAMSES_API const char * getTextureSamplingMethodString (ETextureSamplingMethod samplingMethod)
 Returns string representation for sampling method. More...
 
RAMSES_API const char * getTextureAddressModeString (ETextureAddressMode addressMode)
 Returns string representation for address mode. More...
 
RAMSES_API const char * getTextureFormatString (ETextureFormat format)
 Returns string representation for texture format. More...
 
RAMSES_API const char * getTextureCubeFaceString (ETextureCubeFace face)
 Returns string representation for texture's cube face. More...
 
bool FormatSupportsMipChainGeneration (ETextureFormat format)
 
RAMSES_API RamsesVersion GetRamsesVersion ()
 Retrieve currently used ramses version information. More...
 

Variables

const sequenceTimeStamp_t InvalidSequenceTimeStamp = sequenceTimeStamp_t(-1)
 Time stamp within a sequence local time denoting an invalid value. More...
 
constexpr const status_t StatusOK = 0u
 Status returned from RAMSES client API methods that succeeded. More...
 
constexpr const sceneVersionTag_t InvalidSceneVersionTag = static_cast<sceneVersionTag_t>(-1)
 Scene version tag used to refer to an invalid scene version. More...
 
constexpr const resourceCacheFlag_t ResourceCacheFlag_DoNotCache = resourceCacheFlag_t::Invalid()
 Requests the render to not cache a resource. This is the default value. More...
 

Detailed Description

The RAMSES namespace contains all client side objects and functions used to implement RAMSES applications. RAMSES refers to these applications as clients.

ramses namespace

Typedef Documentation

◆ binaryShaderFormatId_t

using ramses::binaryShaderFormatId_t = typedef StronglyTypedValue<uint32_t, 0, struct binaryShaderFormatIdTag>

Binary shader format identifier used in ramses::IBinaryShaderCache.

◆ Category

using ramses::Category = typedef StronglyTypedValue<uint64_t, 0, CategoryTag>

◆ ContentID

using ramses::ContentID = typedef StronglyTypedValue<uint64_t, 0, ContentIDTag>

Identifier for DCSM content. Must be globally unique.

Examples
ramses-example-dcsm-provider/src/main.cpp, and ramses-example-local-client-dcsm/src/main.cpp.

◆ dataConsumerId_t

using ramses::dataConsumerId_t = typedef StronglyTypedValue<uint32_t, 0, struct DataConsumerIdTag>

Data link identifier used to refer to data consumer and then manage their linkage to data provider using renderer API.

◆ dataProviderId_t

using ramses::dataProviderId_t = typedef StronglyTypedValue<uint32_t, 0, struct DataProviderIdTag>

Data identifier used to refer to data provider and then manage their linkage to data consumer using renderer API.

◆ displayBufferId_t

using ramses::displayBufferId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct DisplayBufferIdTag>

Display buffer identifier referring to either a display's framebuffer or a created offscreen buffer.

Examples
ramses-example-local-client-dcsm/src/main.cpp.

◆ displayId_t

using ramses::displayId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct DisplayIdTag>

Display identifier used to refer to display in renderer API and dispatched callbacks.

Examples
ramses-example-local-client-dcsm/src/main.cpp.

◆ effectId_t

Effect identifier used by the renderer to refer to an effect.

Note: the value is not the same as on client if calling ramses::Resource::getResourceId()

◆ externalBufferId_t

using ramses::externalBufferId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct ExternalBufferIdTag>

External buffer identifier referring to external buffer.

◆ FontId

using ramses::FontId = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), FontIdTag>

A strongly typed integer to distinguish between different fonts.

◆ FontInstanceId

using ramses::FontInstanceId = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), FontInstanceIdTag>

A strongly typed integer to distinguish between different font instances.

◆ FontInstanceOffsets

using ramses::FontInstanceOffsets = typedef std::vector<FontInstanceOffset>

Vector of FontInstanceOffset elements.

◆ globalTimeStamp_t

using ramses::globalTimeStamp_t = typedef uint64_t

Global time stamp type

◆ GlyphData

using ramses::GlyphData = typedef std::vector<uint8_t>

Stores 2-dimensional glyph pixel data as a flat memory array.

◆ GlyphId

using ramses::GlyphId = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), GlyphIdTag>

A strongly typed integer to distinguish between different glyphs.

◆ GlyphKeyVector

using ramses::GlyphKeyVector = typedef std::vector<GlyphKey>

Vector of GlyphKey elements.

◆ GlyphMetricsVector

using ramses::GlyphMetricsVector = typedef std::vector<GlyphMetrics>

Vector of GlyphMetrics elements.

◆ LogHandlerFunc

using ramses::LogHandlerFunc = typedef std::function<void(ELogLevel, const std::string&, const std::string&)>

The LogHandlerFunc can be used to implement a custom log handler. The function is called for each log message separately. Example

ramses::RamsesFramework::SetLogHandler([](ELogLevel logLevel, const std::string& context, const std::string& message){
std::cout << message << std::endl;
});
static void SetLogHandler(const LogHandlerFunc &logHandlerFunc)
ELogLevel
Type of Ramses Log Level.
Definition: RamsesFrameworkTypes.h:177

◆ nodeId_t

using ramses::nodeId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), nodeIdTag>

Node identifier used to refer to a node.

◆ OrderedFontList

using ramses::OrderedFontList = typedef std::vector<FontInstanceId>

vector of FontInstanceId for use in FontCascade

◆ pickableObjectId_t

using ramses::pickableObjectId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), pickableObjectTag>

User ID of a pickable object to be provided when creating ramses::PickableObject.

◆ resourceCacheFlag_t

using ramses::resourceCacheFlag_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), resourceCacheFlagTag>

Cache flag value used for passing a strong-typed flag value to a renderer.

◆ sceneId_t

using ramses::sceneId_t = typedef StronglyTypedValue<uint64_t, 0, struct SceneIdTag>

Scene identifier used to refer to scenes created using client API and then manage their mapping using renderer API.

Examples
ramses-example-dcsm-provider/src/main.cpp.

◆ sceneObjectId_t

ID that is automatically given to ramses::SceneObject on creation.

◆ sceneVersionTag_t

using ramses::sceneVersionTag_t = typedef uint64_t

Scene version tag used to refer to content versions of a scene. A scene version may be updated along with a scene transaction.

◆ sequenceTimeStamp_t

using ramses::sequenceTimeStamp_t = typedef uint32_t

Local sequence time stamp for animation within sequence

◆ splineKeyIndex_t

using ramses::splineKeyIndex_t = typedef uint32_t

Spline key index type

◆ splineTimeStamp_t

using ramses::splineTimeStamp_t = typedef uint32_t

Spline key time stamp type

◆ status_t

using ramses::status_t = typedef uint32_t

Status is a handle to the result of an API call.

All functions of th RAMSES client API that may fail for some reason return a status. This is a handle to request a full status message using getStatusMessage() function.

◆ streamBufferId_t

using ramses::streamBufferId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct StreamBufferIdTag>

Stream buffer identifier referring to Wayland stream.

◆ TechnicalContentDescriptor

Distribution specific descriptor for DCSM content. It allows bindings content IDs to specific distribution mechanism, e.g. ramses scenes via sceneId_t.

◆ TextLineId

using ramses::TextLineId = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), TextLineIdTag>

A strongly typed integer to distinguish between different text lines.

◆ timeMilliseconds_t

using ramses::timeMilliseconds_t = typedef int64_t

Time in milliseconds type

◆ waylandIviLayerId_t

using ramses::waylandIviLayerId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), waylandIviLayerIdTag>

Id assigned to Layer in Wayland with IVI extension.

◆ waylandIviSurfaceId_t

using ramses::waylandIviSurfaceId_t = typedef StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), waylandIviSurfaceIdTag>

Id assigned to Surface in Wayland with IVI extension Also known as "ivi id".

Enumeration Type Documentation

◆ DcsmContentControlEventResult

ramses::DcsmContentControl event result used in some event handler callbacks

Enumerator
OK 

The event (state change) was successful.

TimedOut 

The event (state change) did not happen in given time period and is considered as failed - no change happened.

Examples
ramses-example-local-client-dcsm/src/main.cpp.

◆ EAnimatedProperty

Property to animate for objects that have more than one property that can be animated.

Enumerator
EAnimatedProperty_Translation 
EAnimatedProperty_Rotation 
EAnimatedProperty_Scaling 

◆ EAnimatedPropertyComponent

Vector component ID for binding single/multi component data.

Enumerator
EAnimatedPropertyComponent_X 
EAnimatedPropertyComponent_Y 
EAnimatedPropertyComponent_Z 
EAnimatedPropertyComponent_W 
EAnimatedPropertyComponent_All 

◆ EAnimationSystemFlags

AnimationSystem creation flags.

Enumerator
EAnimationSystemFlags_Default 
EAnimationSystemFlags_ClientSideProcessing 
EAnimationSystemFlags_SynchronizedClock 

uses a synchronized time source for realtime animations (for renderer and client running on different machines)

◆ EBlendFactor

Specifies the blending factor used with blending operation.

Enumerator
EBlendFactor_Zero 
EBlendFactor_One 
EBlendFactor_SrcAlpha 
EBlendFactor_OneMinusSrcAlpha 
EBlendFactor_DstAlpha 
EBlendFactor_OneMinusDstAlpha 
EBlendFactor_SrcColor 
EBlendFactor_OneMinusSrcColor 
EBlendFactor_DstColor 
EBlendFactor_OneMinusDstColor 
EBlendFactor_ConstColor 
EBlendFactor_OneMinusConstColor 
EBlendFactor_ConstAlpha 
EBlendFactor_OneMinusConstAlpha 
EBlendFactor_AlphaSaturate 
EBlendFactor_NUMBER_OF_ELEMENTS 

◆ EBlendOperation

Specifies the blending operation.

Enumerator
EBlendOperation_Disabled 
EBlendOperation_Add 
EBlendOperation_Subtract 
EBlendOperation_ReverseSubtract 
EBlendOperation_Min 
EBlendOperation_Max 
EBlendOperation_NUMBER_OF_ELEMENTS 

◆ EClearFlags

Clear flags used to specify which components of a render target or display buffer should be cleared.

Enumerator
EClearFlags_None 
EClearFlags_Color 
EClearFlags_Depth 
EClearFlags_Stencil 
EClearFlags_All 

◆ ECullMode

Specifies the culling mode.

Enumerator
ECullMode_Disabled 
ECullMode_FrontFacing 
ECullMode_BackFacing 
ECullMode_FrontAndBackFacing 
ECullMode_NUMBER_OF_ELEMENTS 

◆ EDataType

enum ramses::EDataType
strong

Specifies the data type used for creating data buffers.

Enumerator
UInt16 

one component of type uint16_t per data element

UInt32 

one component of type uint32_t per data element

Float 

one component of type float per data element

Vector2F 

two components of type float per data element

Vector3F 

three components of type float per data element

Vector4F 

four components of type float per data element

ByteBlob 

array of raw bytes which gets typed later (e.g. interleaved vertex buffer) where one element is always sized as 1 byte

◆ EDcsmOfferingMode

Specifies mode of offering content LocalOnly: Offer Content only to Consumers within the same process LocalAndRemote: Offer Content to all local and remote Consumers

Enumerator
LocalOnly 
LocalAndRemote 

◆ EDcsmState

enum ramses::EDcsmState
strong

DCSM content states. Used to request a specific state from provider via DcsmConsumer::sendContentStatusChange.

Enumerator
Offered 

Release content to offered state, i.e. no longer assigned to consumer.

Assigned 

Request content to assigned only state.

Ready 

Request content to be prepare to be shown at any time.

Shown 

Request content in shown state, i.e. actively updated.

◆ EDepthBufferType

Specifies type of depth buffer created within an offscreen buffer.

Enumerator
EDepthBufferType_None 
EDepthBufferType_Depth 
EDepthBufferType_DepthStencil 

◆ EDepthFunc

Specifies the depth function.

Enumerator
EDepthFunc_Disabled 
EDepthFunc_Greater 
EDepthFunc_GreaterEqual 
EDepthFunc_Less 
EDepthFunc_LessEqual 
EDepthFunc_Equal 
EDepthFunc_NotEqual 
EDepthFunc_Always 
EDepthFunc_Never 
EDepthFunc_NUMBER_OF_ELEMENTS 

◆ EDepthWrite

Specifies the depth write state.

Enumerator
EDepthWrite_Disabled 
EDepthWrite_Enabled 
EDepthWrite_NUMBER_OF_ELEMENTS 

◆ EDrawMode

Specifies the drawing mode.

Enumerator
EDrawMode_Points 
EDrawMode_Lines 
EDrawMode_Triangles 
EDrawMode_TriangleStrip 
EDrawMode_LineLoop 
EDrawMode_TriangleFan 
EDrawMode_LineStrip 
EDrawMode_NUMBER_OF_ELEMENTS 

◆ EEffectAttributeSemantic

Effect attribute semantic type.

Enumerator
Invalid 

Invalid semantic.

TextPositions 

Text specific - vertex positions input. MUST be of type vec2.

TextTextureCoordinates 

Text specific - texture coordinates input. MUST be of type vec2.

◆ EEffectInputDataType

Data type of effect input.

Enumerator
EEffectInputDataType_Invalid 

Invalid or Unknown data type.

EEffectInputDataType_Int32 

Integer 32bit data type.

EEffectInputDataType_UInt16 

Unsigned integer 16bit data type.

EEffectInputDataType_UInt32 

Unsigned integer 32bit data type.

EEffectInputDataType_Float 

Float data type.

EEffectInputDataType_Vector2F 

Vector2 float data type.

EEffectInputDataType_Vector3F 

Vector3 float data type.

EEffectInputDataType_Vector4F 

Vector4 float data type.

EEffectInputDataType_Vector2I 

Vector2 integer data type.

EEffectInputDataType_Vector3I 

Vector3 integer data type.

EEffectInputDataType_Vector4I 

Vector4 integer data type.

EEffectInputDataType_Matrix22F 

Matrix2x2 data type.

EEffectInputDataType_Matrix33F 

Matrix3x3 data type.

EEffectInputDataType_Matrix44F 

Matrix4x4 data type.

EEffectInputDataType_TextureSampler2D 

2D Texture sampler data type

EEffectInputDataType_TextureSampler2DMS 

2D Texture sampler multi sampled data type

EEffectInputDataType_TextureSampler3D 

3D Texture sampler data type

EEffectInputDataType_TextureSamplerCube 

Cube Texture sampler data type.

EEffectInputDataType_TextureSamplerExternal 

External Texture sampler data type.

◆ EEffectUniformSemantic

Effect uniform semantic type.

Enumerator
Invalid 

Invalid semantic.

ProjectionMatrix 

Projection matrix 4x4.

ModelMatrix 

Mesh model matrix 4x4.

CameraWorldPosition 

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

Camera position vector 3

ViewMatrix 

View matrix 4x4.

ModelViewMatrix 

Model-view matrix 4x4.

ModelViewMatrix33 

Model-view matrix 3x3.

ModelViewProjectionMatrix 

Model-view-projection matrix 4x4.

NormalMatrix 

Transposed and inversed MVP matrix for vertex normals.

DisplayBufferResolution 

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

TextTexture 

Text specific.

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.

◆ EInputType

Specifies the data type of an input.

Enumerator
EInputType_Invalid 
EInputType_Float 
EInputType_Vector2f 
EInputType_Vector3f 
EInputType_Vector4f 
EInputType_Int16 
EInputType_Int32 
EInputType_UInt16 
EInputType_UInt32 
EInputType_Vector2i 
EInputType_Vector3i 
EInputType_Vector4i 
EInputType_Matrix22f 
EInputType_Matrix23f 
EInputType_Matrix24f 
EInputType_Matrix32f 
EInputType_Matrix33f 
EInputType_Matrix34f 
EInputType_Matrix42f 
EInputType_Matrix43f 
EInputType_Matrix44f 
EInputType_TextureSampler 
EInputType_AttributeUInt16 
EInputType_AttributeFloat 
EInputType_AttributeVector2f 
EInputType_AttributeVector3f 
EInputType_AttributeVector4f 
EInputType_NUMBER_OF_ELEMENTS 

◆ EKeyCode

Specifies key codes for keyboard input.

Enumerator
EKeyCode_Unknown 
EKeyCode_A 
EKeyCode_B 
EKeyCode_C 
EKeyCode_D 
EKeyCode_E 
EKeyCode_F 
EKeyCode_G 
EKeyCode_H 
EKeyCode_I 
EKeyCode_J 
EKeyCode_K 
EKeyCode_L 
EKeyCode_M 
EKeyCode_N 
EKeyCode_O 
EKeyCode_P 
EKeyCode_Q 
EKeyCode_R 
EKeyCode_S 
EKeyCode_T 
EKeyCode_U 
EKeyCode_V 
EKeyCode_W 
EKeyCode_X 
EKeyCode_Y 
EKeyCode_Z 
EKeyCode_0 
EKeyCode_1 
EKeyCode_2 
EKeyCode_3 
EKeyCode_4 
EKeyCode_5 
EKeyCode_6 
EKeyCode_7 
EKeyCode_8 
EKeyCode_9 
EKeyCode_NumLock 
EKeyCode_Numpad_Add 
EKeyCode_Numpad_Subtract 
EKeyCode_Numpad_Multiply 
EKeyCode_Numpad_Divide 
EKeyCode_Numpad_Enter 
EKeyCode_Numpad_Decimal 
EKeyCode_Numpad_0 
EKeyCode_Numpad_1 
EKeyCode_Numpad_2 
EKeyCode_Numpad_3 
EKeyCode_Numpad_4 
EKeyCode_Numpad_5 
EKeyCode_Numpad_6 
EKeyCode_Numpad_7 
EKeyCode_Numpad_8 
EKeyCode_Numpad_9 
EKeyCode_Return 
EKeyCode_Escape 
EKeyCode_Backspace 
EKeyCode_Tab 
EKeyCode_Space 
EKeyCode_Menu 
EKeyCode_CapsLock 
EKeyCode_ShiftLeft 
EKeyCode_ShiftRight 
EKeyCode_AltLeft 
EKeyCode_AltRight 
EKeyCode_ControlLeft 
EKeyCode_ControlRight 
EKeyCode_WindowsLeft 
EKeyCode_WindowsRight 
EKeyCode_F1 
EKeyCode_F2 
EKeyCode_F3 
EKeyCode_F4 
EKeyCode_F5 
EKeyCode_F6 
EKeyCode_F7 
EKeyCode_F8 
EKeyCode_F9 
EKeyCode_F10 
EKeyCode_F11 
EKeyCode_F12 
EKeyCode_PrintScreen 
EKeyCode_ScrollLock 
EKeyCode_Pause 
EKeyCode_Insert 
EKeyCode_Home 
EKeyCode_PageUp 
EKeyCode_Delete 
EKeyCode_End 
EKeyCode_PageDown 
EKeyCode_Right 
EKeyCode_Left 
EKeyCode_Up 
EKeyCode_Down 
EKeyCode_Minus 
EKeyCode_Equals 
EKeyCode_LeftBracket 
EKeyCode_RightBracket 
EKeyCode_Backslash 
EKeyCode_Semicolon 
EKeyCode_Comma 
EKeyCode_Period 
EKeyCode_Slash 
EKeyCode_Apostrophe 
EKeyCode_Grave 
EKeyCode_NumberSign 

◆ EKeyEvent

Specifies keypress events for keyboard input.

Enumerator
EKeyEvent_Invalid 
EKeyEvent_Pressed 
EKeyEvent_Released 

◆ EKeyModifier

Specifies key modifiers for keyboard input.

Enumerator
EKeyModifier_NoModifier 
EKeyModifier_Ctrl 
EKeyModifier_Shift 
EKeyModifier_Alt 
EKeyModifier_Function 
EKeyModifier_Numpad 

◆ ELogLevel

enum ramses::ELogLevel
strong

Type of Ramses Log Level.

Enumerator
Off 
Fatal 
Error 
Warn 
Info 
Debug 
Trace 

◆ ELoopMode

Specifies behavior of render loop.

Enumerator
ELoopMode_UpdateAndRender 

Render loop with update content and render.

ELoopMode_UpdateOnly 

Render loop will update content without rendering.

◆ EMouseEvent

Specifies events for mouse input.

Enumerator
EMouseEvent_Invalid 
EMouseEvent_LeftButtonDown 
EMouseEvent_LeftButtonUp 
EMouseEvent_RightButtonDown 
EMouseEvent_RightButtonUp 
EMouseEvent_MiddleButtonDown 
EMouseEvent_MiddleButtonUp 
EMouseEvent_WheelUp 
EMouseEvent_WheelDown 
EMouseEvent_Move 
EMouseEvent_WindowEnter 
EMouseEvent_WindowLeave 

◆ ERamsesObjectType

RamsesObject type ID.

Enumerator
ERamsesObjectType_Invalid 
ERamsesObjectType_ClientObject 
ERamsesObjectType_RamsesObject 
ERamsesObjectType_SceneObject 
ERamsesObjectType_AnimationObject 
ERamsesObjectType_Client 
ERamsesObjectType_Scene 
ERamsesObjectType_AnimationSystem 
ERamsesObjectType_AnimationSystemRealTime 
ERamsesObjectType_Node 
ERamsesObjectType_MeshNode 
ERamsesObjectType_Camera 
ERamsesObjectType_PerspectiveCamera 
ERamsesObjectType_OrthographicCamera 
ERamsesObjectType_Effect 
ERamsesObjectType_AnimatedProperty 
ERamsesObjectType_Animation 
ERamsesObjectType_AnimationSequence 
ERamsesObjectType_Appearance 
ERamsesObjectType_GeometryBinding 
ERamsesObjectType_PickableObject 
ERamsesObjectType_Spline 
ERamsesObjectType_SplineStepBool 
ERamsesObjectType_SplineStepFloat 
ERamsesObjectType_SplineStepInt32 
ERamsesObjectType_SplineStepVector2f 
ERamsesObjectType_SplineStepVector3f 
ERamsesObjectType_SplineStepVector4f 
ERamsesObjectType_SplineStepVector2i 
ERamsesObjectType_SplineStepVector3i 
ERamsesObjectType_SplineStepVector4i 
ERamsesObjectType_SplineLinearFloat 
ERamsesObjectType_SplineLinearInt32 
ERamsesObjectType_SplineLinearVector2f 
ERamsesObjectType_SplineLinearVector3f 
ERamsesObjectType_SplineLinearVector4f 
ERamsesObjectType_SplineLinearVector2i 
ERamsesObjectType_SplineLinearVector3i 
ERamsesObjectType_SplineLinearVector4i 
ERamsesObjectType_SplineBezierFloat 
ERamsesObjectType_SplineBezierInt32 
ERamsesObjectType_SplineBezierVector2f 
ERamsesObjectType_SplineBezierVector3f 
ERamsesObjectType_SplineBezierVector4f 
ERamsesObjectType_SplineBezierVector2i 
ERamsesObjectType_SplineBezierVector3i 
ERamsesObjectType_SplineBezierVector4i 
ERamsesObjectType_Resource 
ERamsesObjectType_Texture2D 
ERamsesObjectType_Texture3D 
ERamsesObjectType_TextureCube 
ERamsesObjectType_ArrayResource 
ERamsesObjectType_RenderGroup 
ERamsesObjectType_RenderPass 
ERamsesObjectType_BlitPass 
ERamsesObjectType_TextureSampler 
ERamsesObjectType_TextureSamplerMS 
ERamsesObjectType_RenderBuffer 
ERamsesObjectType_RenderTarget 
ERamsesObjectType_DataBufferObject 
ERamsesObjectType_Texture2DBuffer 
ERamsesObjectType_DataObject 
ERamsesObjectType_DataFloat 
ERamsesObjectType_DataVector2f 
ERamsesObjectType_DataVector3f 
ERamsesObjectType_DataVector4f 
ERamsesObjectType_DataMatrix22f 
ERamsesObjectType_DataMatrix33f 
ERamsesObjectType_DataMatrix44f 
ERamsesObjectType_DataInt32 
ERamsesObjectType_DataVector2i 
ERamsesObjectType_DataVector3i 
ERamsesObjectType_DataVector4i 
ERamsesObjectType_StreamTexture 
ERamsesObjectType_SceneReference 
ERamsesObjectType_TextureSamplerExternal 
ERamsesObjectType_NUMBER_OF_TYPES 

◆ ERamsesShellType

Type of Ramses Shell.

Enumerator
ERamsesShellType_None 
ERamsesShellType_Console 
ERamsesShellType_Default 

◆ ERamsesThreadIdentifier

Specifies ramses threads

Enumerator
ERamsesThreadIdentifier_Unknown 
ERamsesThreadIdentifier_Workers 
ERamsesThreadIdentifier_Renderer 

◆ ERenderBufferAccessMode

Enum for access mode of a RenderBuffer.

Enumerator
ERenderBufferAccessMode_WriteOnly 

RenderBuffer with this access can only be used in RenderTarget.

ERenderBufferAccessMode_ReadWrite 

RenderBuffer with this access can be used both in RenderTarget and TextureSampler.

◆ ERenderBufferFormat

Enum for format of a RenderBuffer.

Enumerator
ERenderBufferFormat_RGBA4 
ERenderBufferFormat_R8 
ERenderBufferFormat_RG8 
ERenderBufferFormat_RGB8 
ERenderBufferFormat_RGBA8 
ERenderBufferFormat_R16F 
ERenderBufferFormat_R32F 
ERenderBufferFormat_RG16F 
ERenderBufferFormat_RG32F 
ERenderBufferFormat_RGB16F 
ERenderBufferFormat_RGB32F 
ERenderBufferFormat_RGBA16F 
ERenderBufferFormat_RGBA32F 
ERenderBufferFormat_Depth24 
ERenderBufferFormat_Depth24_Stencil8 

◆ ERenderBufferType

Enum for type of a RenderBuffer.

Enumerator
ERenderBufferType_Color 
ERenderBufferType_Depth 
ERenderBufferType_DepthStencil 

◆ ERendererEventResult

Specifies the result of the operation referred to by renderer event.

Enumerator
ERendererEventResult_OK 

Event referring to an operation that succeeded.

ERendererEventResult_INDIRECT 

Event referring to an operation that succeeded but was triggered by another event (eg. unmapped/unsubscribed after scene was unpublished by client)

ERendererEventResult_FAIL 

Event referring to an operation that failed.

Examples
ramses-example-local-client-dcsm/src/main.cpp.

◆ ERenderTargetDepthBufferType

Enum for type of depth buffer created within a RenderTarget.

Enumerator
ERenderTargetDepthBufferType_None 
ERenderTargetDepthBufferType_Depth 
ERenderTargetDepthBufferType_DepthStencil 

◆ ERotationConvention

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 position of the corresponding rotation matrix in the multiplication chain. For example XYZ 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'.

Enumerator
XYZ 

rotates around Z then Y then X axis

XZY 

rotates around Y then Z then X axis

YXZ 

rotates around Z then X then Y axis

YZX 

rotates around X then Z then Y axis

ZXY 

rotates around Y then X then Z axis

ZYX 

rotates around X then Y then Z axis

XYX 

rotates around X then Y then X axis

XZX 

rotates around X then Z then X axis

YXY 

rotates around Y then X then Y axis

YZY 

rotates around Y then Z then Y axis

ZXZ 

rotates around Z then X then Z axis

ZYZ 

rotates around Z then Y then Z axis

◆ EScenePublicationMode

Specifies the mode of scene publication.

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

Enumerator
EScenePublicationMode_LocalAndRemote 
EScenePublicationMode_LocalOnly 

◆ ESceneResourceStatus

Deprecated:
This enum is not used and will be removed.
Enumerator
ESceneResourceStatus_Pending 
Deprecated:
ESceneResourceStatus_Ready 
Deprecated:

◆ EScissorTest

Specifies the scissor test state.

Enumerator
EScissorTest_Disabled 
EScissorTest_Enabled 
EScissorTest_NUMBER_OF_ELEMENTS 

◆ EStencilFunc

Specifies the stencil function.

Enumerator
EStencilFunc_Disabled 
EStencilFunc_Never 
EStencilFunc_Always 
EStencilFunc_Equal 
EStencilFunc_NotEqual 
EStencilFunc_Less 
EStencilFunc_LessEqual 
EStencilFunc_Greater 
EStencilFunc_GreaterEqual 
EStencilFunc_NUMBER_OF_ELEMENTS 

◆ EStencilOperation

Specifies the stencil operation.

Enumerator
EStencilOperation_Keep 
EStencilOperation_Zero 
EStencilOperation_Replace 
EStencilOperation_Increment 
EStencilOperation_IncrementWrap 
EStencilOperation_Decrement 
EStencilOperation_DecrementWrap 
EStencilOperation_Invert 
EStencilOperation_NUMBER_OF_ELEMENTS 

◆ ETechnicalContentType

Enum describing the possible distribution mechanisms for a specific content.

Enumerator
RamsesSceneID 
WaylandIviSurfaceID 

◆ ETextureAddressMode

Texture address mode.

Enumerator
ETextureAddressMode_Clamp 
ETextureAddressMode_Repeat 
ETextureAddressMode_Mirror 
ETextureAddressMode_NUMBER_OF_ELEMENTS 

◆ ETextureChannelColor

enum ramses::ETextureChannelColor : uint8_t
strong

Enum for color of texture channel.

Enumerator
Red 
Green 
Blue 
Alpha 
One 
Zero 

◆ ETextureCubeFace

Cube texture face identifier.

Enumerator
ETextureCubeFace_PositiveX 
ETextureCubeFace_NegativeX 
ETextureCubeFace_PositiveY 
ETextureCubeFace_NegativeY 
ETextureCubeFace_PositiveZ 
ETextureCubeFace_NegativeZ 
ETextureCubeFace_NUMBER_OF_ELEMENTS 

◆ ETextureFormat

Texture data format.

Enumerator
Invalid 
R8 
RG8 
RGB8 
RGB565 
RGBA8 
RGBA4 
RGBA5551 
ETC2RGB 
ETC2RGBA 
R16F 
R32F 
RG16F 
RG32F 
RGB16F 
RGB32F 
RGBA16F 
RGBA32F 
SRGB8 
SRGB8_ALPHA8 
ASTC_RGBA_4x4 
ASTC_RGBA_5x4 
ASTC_RGBA_5x5 
ASTC_RGBA_6x5 
ASTC_RGBA_6x6 
ASTC_RGBA_8x5 
ASTC_RGBA_8x6 
ASTC_RGBA_8x8 
ASTC_RGBA_10x5 
ASTC_RGBA_10x6 
ASTC_RGBA_10x8 
ASTC_RGBA_10x10 
ASTC_RGBA_12x10 
ASTC_RGBA_12x12 
ASTC_SRGBA_4x4 
ASTC_SRGBA_5x4 
ASTC_SRGBA_5x5 
ASTC_SRGBA_6x5 
ASTC_SRGBA_6x6 
ASTC_SRGBA_8x5 
ASTC_SRGBA_8x6 
ASTC_SRGBA_8x8 
ASTC_SRGBA_10x5 
ASTC_SRGBA_10x6 
ASTC_SRGBA_10x8 
ASTC_SRGBA_10x10 
ASTC_SRGBA_12x10 
ASTC_SRGBA_12x12 
NUMBER_OF_ELEMENTS 

◆ ETextureSamplingMethod

Texture sampling method.

Enumerator
ETextureSamplingMethod_Nearest 
ETextureSamplingMethod_Linear 
ETextureSamplingMethod_Nearest_MipMapNearest 
ETextureSamplingMethod_Nearest_MipMapLinear 
ETextureSamplingMethod_Linear_MipMapNearest 
ETextureSamplingMethod_Linear_MipMapLinear 
ETextureSamplingMethod_NUMBER_OF_ELEMENTS 

◆ ETreeTraversalStyle

Tree traversal style.

Enumerator
ETreeTraversalStyle_DepthFirst 
ETreeTraversalStyle_BreadthFirst 

◆ EValidationSeverity

The EValidationSeverity defines severity of validation results.

Enumerator
EValidationSeverity_Info 
EValidationSeverity_Warning 
EValidationSeverity_Error 

◆ EVisibilityMode

enum ramses::EVisibilityMode : uint32_t
strong

Specifies the mode of node visibility.

Enumerator
Off 

A node shall be invisible and the node shall not trigger its resources to be loaded.

Invisible 

A node shall be invisible, but the node shall trigger its resources to be loaded.

Visible 

A node shall be fully loaded and visible.

◆ RendererSceneState

enum ramses::RendererSceneState : uint8_t
strong

State of a scene on renderer, used with ramses::RendererSceneControl, ramses::IRendererSceneControlEventHandler or ramses::SceneReference

Enumerator
Unavailable 

Scene is unavailable, no scene control possible.

Available 

Scene is available, but not prepared for rendering. Can be requested to be ready or rendered.

Ready 

Scene is ready to start rendering (its resources are uploaded).

Rendered 

Scene is being rendered.

Function Documentation

◆ FormatSupportsMipChainGeneration()

bool ramses::FormatSupportsMipChainGeneration ( ETextureFormat  format)
inline

Returns if given texture format supports mipmap chain generation

Parameters
formatthe format in question
Returns
true if given format supports generation of mipchain

◆ getBlendFactorString()

RAMSES_API const char* ramses::getBlendFactorString ( EBlendFactor  blendFactor)

Returns string representation for blend factor.

Useful for logging, etc.

Parameters
blendFactorThe enum parameter for which you will get the string
Returns
String representation of the blend factor

◆ getBlendOperationString()

RAMSES_API const char* ramses::getBlendOperationString ( EBlendOperation  blendOperation)

Returns string representation for blend operation.

Useful for logging, etc.

Parameters
blendOperationThe enum parameter for which you will get the string
Returns
String representation of the blend operation

◆ getCullModeString()

RAMSES_API const char* ramses::getCullModeString ( ECullMode  cullMode)

Returns string representation for cull mode.

Useful for logging, etc.

Parameters
cullModeThe enum parameter for which you will get the string
Returns
String representation of the cull mode

◆ getDepthFuncString()

RAMSES_API const char* ramses::getDepthFuncString ( EDepthFunc  depthFunc)

Returns string representation for depth function.

Useful for logging, etc.

Parameters
depthFuncThe enum parameter for which you will get the string
Returns
String representation of the depth function

◆ getDepthWriteString()

RAMSES_API const char* ramses::getDepthWriteString ( EDepthWrite  depthWrite)

Returns string representation for depth write.

Useful for logging, etc.

Parameters
depthWriteThe enum parameter for which you will get the string
Returns
String representation of the depth write

◆ getDrawModeString()

RAMSES_API const char* ramses::getDrawModeString ( EDrawMode  drawMode)

Returns string representation for draw mode.

Useful for logging, etc.

Parameters
drawModeThe enum parameter for which you will get the string
Returns
String representation of the draw mode

◆ getInputTypeString()

RAMSES_API const char* ramses::getInputTypeString ( EInputType  inputType)

Returns string representation for input type.

Useful for logging, etc.

Parameters
inputTypeThe enum parameter for which you will get the string
Returns
String representation of the input type

◆ GetNumberOfComponents()

constexpr size_t ramses::GetNumberOfComponents ( EDataType  dataType)
constexpr

Retrieve number of components per element of specified data type.

Parameters
[in]dataTypeData type to be queried
Returns
number of components per element

◆ GetRamsesVersion()

RAMSES_API RamsesVersion ramses::GetRamsesVersion ( )

Retrieve currently used ramses version information.

Returns
the ramses version of the currently used build

◆ getScissorTestString()

RAMSES_API const char* ramses::getScissorTestString ( EScissorTest  scissorTest)

Returns string representation for scissor test.

Useful for logging, etc.

Parameters
scissorTestThe enum parameter for which you will get the string
Returns
String representation of the scissor test

◆ GetSizeOfComponent()

constexpr size_t ramses::GetSizeOfComponent ( EDataType  dataType)
constexpr

Retrieve size of one component of specified data type in bytes.

For EDataType::ByteBlob element size is defined to be 1 byte.

Parameters
[in]dataTypeData type to be queried
Returns
Size of a component of the data type in bytes

◆ GetSizeOfDataType()

constexpr size_t ramses::GetSizeOfDataType ( EDataType  dataType)
constexpr

Retrieve size of one element of specified data type in bytes.

Parameters
[in]dataTypeData type to be queried
Returns
Size of one element of the data type in bytes

◆ getStencilFuncString()

RAMSES_API const char* ramses::getStencilFuncString ( EStencilFunc  stencilFunc)

Returns string representation for stencil function.

Useful for logging, etc.

Parameters
stencilFuncThe enum parameter for which you will get the string
Returns
String representation of the stencil function

◆ getStencilOperationString()

RAMSES_API const char* ramses::getStencilOperationString ( EStencilOperation  stencilOp)

Returns string representation for stencil operation.

Useful for logging, etc.

Parameters
stencilOpThe enum parameter for which you will get the string
Returns
String representation of the stencil operation

◆ getTextureAddressModeString()

RAMSES_API const char* ramses::getTextureAddressModeString ( ETextureAddressMode  addressMode)

Returns string representation for address mode.

Useful for logging, etc.

Parameters
addressModeThe enum parameter for which you will get the string
Returns
String representation of the address mode

◆ getTextureCubeFaceString()

RAMSES_API const char* ramses::getTextureCubeFaceString ( ETextureCubeFace  face)

Returns string representation for texture's cube face.

Useful for logging, etc.

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

◆ getTextureFormatString()

RAMSES_API const char* ramses::getTextureFormatString ( ETextureFormat  format)

Returns string representation for texture format.

Useful for logging, etc.

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

◆ getTextureSamplingMethodString()

RAMSES_API const char* ramses::getTextureSamplingMethodString ( ETextureSamplingMethod  samplingMethod)

Returns string representation for sampling method.

Useful for logging, etc.

Parameters
samplingMethodThe enum parameter for which you will get the string
Returns
String representation of the sampling method

Variable Documentation

◆ InvalidSceneVersionTag

constexpr const sceneVersionTag_t ramses::InvalidSceneVersionTag = static_cast<sceneVersionTag_t>(-1)
constexpr

Scene version tag used to refer to an invalid scene version.

Examples
ramses-example-local-dma-offscreenbuffer/src/main.cpp, and ramses-example-local-offscreenbuffer/src/main.cpp.

◆ InvalidSequenceTimeStamp

const sequenceTimeStamp_t ramses::InvalidSequenceTimeStamp = sequenceTimeStamp_t(-1)

Time stamp within a sequence local time denoting an invalid value.

◆ ResourceCacheFlag_DoNotCache

constexpr const resourceCacheFlag_t ramses::ResourceCacheFlag_DoNotCache = resourceCacheFlag_t::Invalid()
constexpr

Requests the render to not cache a resource. This is the default value.

Examples
ramses-example-basic-animation-realtime/src/main.cpp, ramses-example-basic-animation/src/main.cpp, ramses-example-basic-blending/src/main.cpp, ramses-example-basic-compositing/src/main.cpp, ramses-example-basic-effect-from-glsl/src/main.cpp, ramses-example-basic-file-loading/src/main.cpp, ramses-example-basic-geometry/src/main.cpp, ramses-example-basic-rendergroups/src/main.cpp, ramses-example-basic-renderpasses/src/main.cpp, ramses-example-basic-rendertarget/src/main.cpp, ramses-example-basic-scenegraph/src/main.cpp, ramses-example-basic-texturing/src/main.cpp, ramses-example-data-buffers-texture/src/main.cpp, ramses-example-data-buffers-vertices/src/main.cpp, ramses-example-dcsm-provider/src/main.cpp, ramses-example-geometry-instancing/src/main.cpp, ramses-example-interleaved-vertex-buffers/src/main.cpp, ramses-example-local-client-dcsm/src/main.cpp, ramses-example-local-client/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-displays/src/main.cpp, ramses-example-local-dma-offscreenbuffer/src/main.cpp, ramses-example-local-geometry-shaders/src/main.cpp, ramses-example-local-offscreenbuffer/src/main.cpp, ramses-example-local-pick-handling/src/main.cpp, ramses-example-local-scene-referencing/src/main.cpp, ramses-example-local-viewport-link/src/main.cpp, ramses-example-renderonce/src/main.cpp, ramses-example-text-basic/src/main.cpp, and ramses-example-text-languages/src/main.cpp.

◆ StatusOK

constexpr const status_t ramses::StatusOK = 0u
constexpr

Status returned from RAMSES client API methods that succeeded.

Examples
ramses-example-local-dma-offscreenbuffer/src/main.cpp, and ramses-example-local-offscreenbuffer/src/main.cpp.