RamsesFrameworkTypes.h File Reference

#include "ramses-framework-api/StronglyTypedValue.h"
#include "stdint.h"
#include <limits>
#include <string>

Go to the source code of this file.

Classes
struct	ramses::SceneIdTag
	Struct used as unique id for the strongly typed scene id. More...
struct	ramses::resourceId_t
	Resource identifier used to refer to a resource. More...
struct	ramses::nodeIdTag
	Struct used as unique id for the strongly typed node Id. More...
struct	ramses::resourceCacheFlagTag
	Struct used as unique id for the strongly-typed cache flag. More...
struct	ramses::pickableObjectTag
	Dummy struct to uniquely define ramses::pickableObjectId_t. More...
struct	ramses::sceneObjectTag
	Dummy struct to uniquely define ramses::sceneObjectId_t. More...
struct	ramses::waylandIviSurfaceIdTag
	Struct used as unique id for the strongly typed Wayland IVI Surface Id. More...
struct	ramses::waylandIviLayerIdTag
	Struct used as unique id for the strongly typed Wayland IVI Layer Id. More...

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

Typedefs
using	ramses::status_t = uint32_t
	Status is a handle to the result of an API call. More...
using	ramses::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	ramses::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	ramses::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	ramses::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	ramses::streamBufferId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), struct StreamBufferIdTag >
	Stream buffer identifier referring to Wayland stream. More...
using	ramses::externalBufferId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), struct ExternalBufferIdTag >
	External buffer identifier referring to external buffer. More...
using	ramses::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	ramses::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	ramses::nodeId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), nodeIdTag >
	Node identifier used to refer to a node. More...
using	ramses::LogHandlerFunc = std::function< void(ELogLevel, const std::string &, const std::string &)>
using	ramses::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	ramses::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	ramses::binaryShaderFormatId_t = StronglyTypedValue< uint32_t, 0, struct binaryShaderFormatIdTag >
	Binary shader format identifier used in ramses::IBinaryShaderCache. More...
using	ramses::sceneObjectId_t = StronglyTypedValue< uint64_t, 0, sceneObjectTag >
	ID that is automatically given to ramses::SceneObject on creation. More...
using	ramses::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	ramses::waylandIviLayerId_t = StronglyTypedValue< uint32_t, std::numeric_limits< uint32_t >::max(), waylandIviLayerIdTag >
	Id assigned to Layer in Wayland with IVI extension. More...

Enumerations
enum	ramses::ERamsesShellType { ramses::ERamsesShellType_None = 0 , ramses::ERamsesShellType_Console , ramses::ERamsesShellType_Default }
	Type of Ramses Shell. More...
enum class	ramses::ELogLevel {   ramses::Off , ramses::Fatal , ramses::Error , ramses::Warn ,   ramses::Info , ramses::Debug , ramses::Trace }
	Type of Ramses Log Level. More...
enum	ramses::EClearFlags {   ramses::EClearFlags_None = 0 , ramses::EClearFlags_Color = 1 << 0 , ramses::EClearFlags_Depth = 1 << 1 , ramses::EClearFlags_Stencil = 1 << 2 ,   ramses::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...

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