Cubios::Gfx::OffscreenRenderTarget

Public Enums

renderLayerOrder_t

Summary

Determines the drawing order of the main and auxiliary layers:

• BeforeQueue - The auxiliary layer is drawn before the main one
• AfterQueue - The auxiliary layer is drawn after the main one

Synopsis

1enum renderLayerOrder_t
2    {
3        BeforeQueue = 0,
4        AfterQueue = 1
5    };
6 

Constructors

OffscreenRenderTarget

Constructs an object for rendering the GFX objects queue to an offscreen bitmap for later use

Arguments

• width - width of the offscreen render target bitmap, in pixels
• height - height of the offscreen render target bitmap, in pixels
• format - render target pixel format

Synopsis

1OffscreenRenderTarget(u32_t width, u32_t height, Cubios::GFX_PixelFormat_t format)
2 

Public Methods

Add

Summary

Adds an instance of GFX object to the rendering queue

Arguments

• obj - pointer to an instance of GFX object

Output

Returns a pointer to the recently added object

Synopsis

1Cubios::SceneObject* Add(Cubios::SceneObject* obj)
2 

AddCopy

Summary

Adds a copy of GFX object to the rendering queue

Arguments

• obj - pointer to an instance of GFX object a copy of which will be added to the queue

Output

Returns a pointer to the recently added object

Synopsis

1Cubios::SceneObject* AddCopy(Cubios::SceneObject* obj)
2 

Begin

Summary

Initializes a commit of objects and is called before the immediate start of adding objects to the queue

Synopsis

1void Begin()
2 

End

Summary

Finalizes the commit of objects to the queue and submits the added objects for rendering

Synopsis

1void End()
2 

Public Virtual Methods

RenderLayer

Summary

This function can contain auxiliary layer rendering code that runs either before or after the main layer is rendered.

Arguments

• order - auxiliary layer rendering order

Synopsis

1virtual void RenderLayer(renderLayerOrder_t order)
2