gem::ICanvasBufferRenderer Class Reference

Canvas Wrapper that renders a image based on OpenGL. More...

Inheritance diagram for gem::ICanvasBufferRenderer:

Collaboration diagram for gem::ICanvasBufferRenderer:

Public Member Functions
virtual void	SetFrameFit (EFrameFit value)=0
	Set image fit setting.
virtual EFrameFit	GetFrameFit () const =0
	Get image fit setting.
virtual XyF	GetScaleFactor () const =0
	Scaling factors based on frame fit setting.
virtual XyF	GetTranslateFactor () const =0
	Translate factors based on frame fit setting.
virtual StrongPointer< Canvas >	GetCanvas () const =0
virtual void	RenderFrame ()=0
	Renders last uploaded frame.
virtual void	UpdateFrame (std::shared_ptr< sense::ICamera > cameraData)=0
	Caches a camera image to be rendered later.
virtual void	UpdateFrame (std::shared_ptr< IBitmap > image, EOrientationType orientation)=0
	Caches an image to be rendered later.
virtual void	Release ()=0
	Empty release.

Detailed Description

Canvas Wrapper that renders a image based on OpenGL.

Member Function Documentation

GetCanvas()

virtual StrongPointer< Canvas > gem::ICanvasBufferRenderer::GetCanvas ( ) const

pure virtual

Returns

Parent canvas

GetFrameFit()

virtual EFrameFit gem::ICanvasBufferRenderer::GetFrameFit ( ) const

pure virtual

Get image fit setting.

Returns

Current frame fit setting.

GetScaleFactor()

virtual XyF gem::ICanvasBufferRenderer::GetScaleFactor ( ) const

pure virtual

Scaling factors based on frame fit setting.

[scaleX, scaleY]

Returns

Scale factors

GetTranslateFactor()

virtual XyF gem::ICanvasBufferRenderer::GetTranslateFactor ( ) const

pure virtual

Translate factors based on frame fit setting.

[translateX, translateY]

Returns

Translate factors

RenderFrame()

virtual void gem::ICanvasBufferRenderer::RenderFrame ( )

pure virtual

Renders last uploaded frame.

Note

Must be called when needed from GL thread.

SetFrameFit()

virtual void gem::ICanvasBufferRenderer::SetFrameFit ( EFrameFit value )

pure virtual

Set image fit setting.

Parameters

value

desired value

UpdateFrame() [1/2]

virtual void gem::ICanvasBufferRenderer::UpdateFrame ( std::shared_ptr< IBitmap > image, EOrientationType orientation )

pure virtual

Caches an image to be rendered later.

Parameters

image	Image.
orientation	Image orientation type.

UpdateFrame() [2/2]

virtual void gem::ICanvasBufferRenderer::UpdateFrame ( std::shared_ptr< sense::ICamera > cameraData )

pure virtual

Caches a camera image to be rendered later.

Parameters

cameraData

Camera data.