gem::CanvasBufferRenderer Class Reference

Buffer renderer object. More...

Inheritance diagram for gem::CanvasBufferRenderer:

Collaboration diagram for gem::CanvasBufferRenderer:

Classes
struct	__allow_private_constructor

Public Member Functions
void	setFrameFit (EFrameFit value)
	Set image fit setting.
EFrameFit	getFrameFit () const
	Get image fit setting.
XyF	getScaleFactor () const
	Scaling factors based on frame fit setting.
XyF	getTranslateFactor () const
	Translate factors based on frame fit setting.
StrongPointer< Canvas >	getCanvas () const noexcept
void	renderFrame ()
	Renders last uploaded frame.
void	updateFrame (std::shared_ptr< sense::ICamera > cameraData)
	Caches a camera image to be rendered later.
void	updateFrame (std::shared_ptr< IBitmap > image, EOrientationType orientation)
	Caches an image to be rendered later.

Static Public Member Functions
static StrongPointer< CanvasBufferRenderer >	produce (StrongPointer< Canvas > canvas)
	Create a buffer renderer based on a canvas object.

Protected Types
using	Base = ApiObject<ICanvasBufferRenderer, false>
	Alias Base class.

Detailed Description

Buffer renderer object.

Will draw raw image buffers on a canvas.

Member Function Documentation

getCanvas()

StrongPointer< Canvas > gem::CanvasBufferRenderer::getCanvas ( ) const

inlinenoexcept

Returns

Parent canvas

getFrameFit()

EFrameFit gem::CanvasBufferRenderer::getFrameFit ( ) const

inline

Get image fit setting.

Returns

Current frame fit setting.

getScaleFactor()

XyF gem::CanvasBufferRenderer::getScaleFactor ( ) const

inline

Scaling factors based on frame fit setting.

[scaleX, scaleY]

Returns

Scale factors

getTranslateFactor()

XyF gem::CanvasBufferRenderer::getTranslateFactor ( ) const

inline

Translate factors based on frame fit setting.

[translateX, translateY]

Returns

Translate factors

produce()

StrongPointer< CanvasBufferRenderer > gem::CanvasBufferRenderer::produce ( StrongPointer< Canvas > canvas )

inlinestatic

Create a buffer renderer based on a canvas object.

Parameters

[in]

canvas

The canvas

Returns

The buffer renderer

renderFrame()

void gem::CanvasBufferRenderer::renderFrame ( )

inline

Renders last uploaded frame.

Note

Must be called when needed from GL thread.

setFrameFit()

void gem::CanvasBufferRenderer::setFrameFit ( EFrameFit value )

inline

Set image fit setting.

Parameters

value

desired value

updateFrame() [1/2]

void gem::CanvasBufferRenderer::updateFrame ( std::shared_ptr< IBitmap > image, EOrientationType orientation )

inline

Caches an image to be rendered later.

Parameters

image	Image.
orientation	Image orientation type.

updateFrame() [2/2]

void gem::CanvasBufferRenderer::updateFrame ( std::shared_ptr< sense::ICamera > cameraData )

inline

Caches a camera image to be rendered later.

Parameters

cameraData

Camera data.