CYIOffscreenRenderTarget Class Reference

Detailed Description

Defines an offscreen target for the rendering results to be sent to.

Offscreen types will be rendered into framebuffer objects that can be used, after rendering, as textures.

For an offscreen target, even though it would be possible to calculate target dimensions based on the union of the bounding boxes of the children, it is better to set it directly by the specified AE composition size. Once this target is created, its dimensions will not change.

See also

CYIRenderTarget

#include <renderer/YiOffscreenRenderTarget.h>

Inheritance diagram for CYIOffscreenRenderTarget:

Public Member Functions
	~CYIOffscreenRenderTarget ()
void	SetFramebufferAsset (const std::shared_ptr< CYIAssetFramebuffer > &pFramebuffer)
void	SetTargetSize (uint32_t uWidth, uint32_t uHeight)
Public Member Functions inherited from CYIRenderTarget
virtual	~CYIRenderTarget ()
void	SetViewport (const CYIViewport &viewport)
const CYIViewport &	GetViewport () const
std::shared_ptr< IYIGPUObject >	GetFramebuffer () const
std::shared_ptr< CYIAssetFramebuffer >	GetFramebufferAsset () const
RENDER_TARGET_TYPE	GetTargetType () const
void	SetDeviceHorizontalPixelRatio (float fDevicePixelRatio)
void	SetDeviceVerticalPixelRatio (float fDevicePixelRatio)
void	SetDeviceDiagonalPixelRatio (float fDevicePixelRatio)
float	GetDeviceHorizontalPixelRatio () const
float	GetDeviceVerticalPixelRatio () const
float	GetDeviceDiagonalPixelRatio () const
void	SetClearColor (const CYIColor &clearColor)
const CYIColor &	GetClearColor () const
void	SetAttribute (RENDER_TARGET_ATTRIBUTE eAttribute, bool bValue)
bool	GetAttribute (RENDER_TARGET_ATTRIBUTE eAttribute) const

Friends
class	CYIRenderTarget

Additional Inherited Members
Public Types inherited from CYIRenderTarget
enum	RENDER_TARGET_ATTRIBUTE {   CLEAR_COLOR_BUFFER = 1,   CLEAR_DEPTH_BUFFER = 2,   CLEAR = CLEAR_COLOR_BUFFER | CLEAR_DEPTH_BUFFER }
enum	RENDER_TARGET_TYPE {   SCREEN = 1,   OFFSCREEN_COLOR_ONLY,   OFFSCREEN_DEPTH_ONLY,   OFFSCREEN_COLOR_AND_DEPTH }
Static Public Member Functions inherited from CYIRenderTarget
static std::unique_ptr< CYIScreenRenderTarget >	CreateScreenTarget (const CYIViewport &viewport)
static std::unique_ptr< CYIOffscreenRenderTarget >	CreateOffscreenTarget (RENDER_TARGET_TYPE eTargetType, uint32_t uTargetWidth, uint32_t uTargetHeight)
Protected Member Functions inherited from CYIRenderTarget
	CYIRenderTarget ()
Protected Attributes inherited from CYIRenderTarget
std::shared_ptr< CYIAssetFramebuffer >	m_pFramebuffer

Constructor & Destructor Documentation

CYIOffscreenRenderTarget::~CYIOffscreenRenderTarget

(

)

Member Function Documentation

void CYIOffscreenRenderTarget::SetFramebufferAsset

(

const std::shared_ptr< CYIAssetFramebuffer > &

pFramebuffer

)

Sets the framebuffer asset for this render target. This will be the destination buffer to which content will be rendered.

void CYIOffscreenRenderTarget::SetTargetSize	(	uint32_t	uWidth,
		uint32_t	uHeight
	)

Updates the target size for offscreen targets.

Friends And Related Function Documentation

friend class CYIRenderTarget

friend

---

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

• renderer/YiOffscreenRenderTarget.h