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

#include <BlitPass.h>

Inheritance diagram for ramses::BlitPass:

[legend]

Collaboration diagram for ramses::BlitPass:

[legend]

Public Member Functions
const RenderBuffer &	getSourceRenderBuffer () const
	Get the source render buffer used for blitting. More...

const RenderBuffer &	getDestinationRenderBuffer () const
	Get the destination render buffer used for blitting. More...

status_t	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. More...

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

status_t	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. More...

int32_t	getRenderOrder () const
	Get the render order of this blit pass. More...

status_t	setEnabled (bool enable)
	Enable/Disable blit pass. More...

bool	isEnabled () const
	Get the enable state of the blit pass. More...

Public Member Functions inherited from ramses::SceneObject
sceneObjectId_t	getSceneObjectId () const
	Returns scene object id which is automatically assigned at creation time of object and is unique within scope of one scene. More...

sceneId_t	getSceneId () const
	Returns sceneid to which this object belongs to. More...

Public Member Functions inherited from ramses::RamsesObject
const char *	getName () const
	Returns the name of the object. More...

status_t	setName (const char *name)
	Changes the name of the object. More...

ERamsesObjectType	getType () const
	Gets type of the object. More...

bool	isOfType (ERamsesObjectType type) const
	Checks if the object is of given type. More...

Public Member Functions inherited from ramses::StatusObject
status_t	validate () const
	Generates verbose validation of the object. More...

const char *	getValidationReport (EValidationSeverity minSeverity=EValidationSeverity_Info) const
	Provides verbose report in human readable form generated by validate. More...

const char *	getStatusMessage (status_t status) const
	Get the string description for a status provided by a RAMSES API function. More...

	StatusObject (const StatusObject &other)=delete
	Deleted copy constructor. More...

StatusObject &	operator= (const StatusObject &other)=delete
	Deleted copy assignment. More...

Public Attributes
class BlitPassImpl &	impl

Public Attributes inherited from ramses::SceneObject
class SceneObjectImpl &	impl

Public Attributes inherited from ramses::ClientObject
class ClientObjectImpl &	impl

Public Attributes inherited from ramses::RamsesObject
class RamsesObjectImpl &	impl

Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl &	impl

Protected Member Functions
	BlitPass (BlitPassImpl &pimpl)
	Constructor for BlitPass. More...

virtual	~BlitPass ()
	Destructor of the BlitPass. More...

Protected Member Functions inherited from ramses::SceneObject
	SceneObject (SceneObjectImpl &pimpl)
	Constructor for SceneObject. More...

virtual	~SceneObject ()
	Destructor of the SceneObject. More...

Protected Member Functions inherited from ramses::ClientObject
	ClientObject (ClientObjectImpl &pimpl)
	Constructor for ClientObject. More...

virtual	~ClientObject ()
	Destructor of the ClientObject. More...

Protected Member Functions inherited from ramses::RamsesObject
	RamsesObject (RamsesObjectImpl &pimpl)
	Constructor for RamsesObject. More...

virtual	~RamsesObject ()
	Destructor of the RamsesObject. More...

Protected Member Functions inherited from ramses::StatusObject
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...

virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Friends
class	SceneImpl
	Scene is the factory for creating BlitPass instances. More...

Detailed Description

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.

Constructor & Destructor Documentation

◆ BlitPass()

ramses::BlitPass::BlitPass ( BlitPassImpl & pimpl )

explicitprotected

Constructor for BlitPass.

Parameters

pimpl Internal data for implementation specifics of BlitPass (sink - instance becomes owner)

◆ ~BlitPass()

virtual ramses::BlitPass::~BlitPass ( )

protectedvirtual

Destructor of the BlitPass.

Member Function Documentation

◆ getBlittingRegion()

void ramses::BlitPass::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

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

◆ getDestinationRenderBuffer()

const RenderBuffer& ramses::BlitPass::getDestinationRenderBuffer ( ) const

Get the destination render buffer used for blitting.

Returns: The destination render buffer.

◆ getRenderOrder()

int32_t ramses::BlitPass::getRenderOrder ( ) const

Get the render order of this blit pass.

Returns: The render order of this blit pass.

◆ getSourceRenderBuffer()

const RenderBuffer& ramses::BlitPass::getSourceRenderBuffer ( ) const

Get the source render buffer used for blitting.

Returns: The source render buffer.

◆ isEnabled()

bool ramses::BlitPass::isEnabled ( ) const

Get the enable state of the blit pass.

Returns: Indicates if the blit pass is enabled

◆ setBlittingRegion()

status_t ramses::BlitPass::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: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setEnabled()

status_t ramses::BlitPass::setEnabled ( bool enable )

Enable/Disable blit pass.

Parameters

enable The enable flag which indicates if the blit pass is rendered (Default:true)

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setRenderOrder()

status_t ramses::BlitPass::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: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

Friends And Related Function Documentation

◆ SceneImpl

friend class SceneImpl

friend

Scene is the factory for creating BlitPass instances.

Member Data Documentation

◆ impl

class BlitPassImpl& ramses::BlitPass::impl

Stores internal data for implementation specifics of BlitPass.

The documentation for this class was generated from the following file:

/home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-client-api/BlitPass.h

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BlitPass()

◆ ~BlitPass()

Member Function Documentation

◆ getBlittingRegion()

◆ getDestinationRenderBuffer()

◆ getRenderOrder()

◆ getSourceRenderBuffer()

◆ isEnabled()

◆ setBlittingRegion()

◆ setEnabled()

◆ setRenderOrder()

Friends And Related Function Documentation

◆ SceneImpl

Member Data Documentation

◆ impl