IRenderTarget Class Reference

#include <irendertarget.h>

Public Member Functions
virtual void	beginRendering ()=0
virtual void	endRendering ()=0
virtual const glm::ivec2	getBufferSize () const =0
virtual void	setClearColor (const RGBAColorFloat &color)=0
virtual const RGBAColorFloat &	getClearColor () const =0
virtual ECullWindingOrder	getWindingOrder () const =0
virtual VkFormat	getColorFormat () const =0
virtual VkFormat	getDepthFormat () const =0
virtual VkRenderPass	getRenderPass () const =0
virtual VkSampleCountFlagBits	getSampleCount () const =0
virtual bool	getSampleShadingEnabled () const =0
virtual VkImageLayout	getFinalLayout () const =0

Description

Interface for all render targets, including nap::RenderWindow and nap::RenderTarget.

Inheritance diagram for IRenderTarget:

Member Function Documentation

beginRendering()

virtual void beginRendering ( )

pure virtual

Should start the render pass

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

endRendering()

virtual void endRendering ( )

pure virtual

Should end the render pass

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getBufferSize()

virtual const glm::ivec2 getBufferSize ( ) const

pure virtual

Returns

the size of the buffer in pixels

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getClearColor()

virtual const RGBAColorFloat& getClearColor ( ) const

pure virtual

Returns

the clear color

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getColorFormat()

virtual VkFormat getColorFormat ( ) const

pure virtual

Returns

used color format

Implemented in RenderWindow, ColorDepthRenderTarget, DepthRenderTarget, RenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getDepthFormat()

virtual VkFormat getDepthFormat ( ) const

pure virtual

Returns

used depth format

Implemented in RenderWindow, ColorDepthRenderTarget, DepthRenderTarget, RenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getFinalLayout()

virtual VkImageLayout getFinalLayout ( ) const

pure virtual

Returns

image layout when render pass ends

Implemented in RenderWindow, ColorDepthRenderTarget, RenderTarget, DepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getRenderPass()

virtual VkRenderPass getRenderPass ( ) const

pure virtual

Returns

the render pass

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getSampleCount()

virtual VkSampleCountFlagBits getSampleCount ( ) const

pure virtual

Returns

number of samples

Implemented in RenderWindow, ColorDepthRenderTarget, RenderTarget, DepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getSampleShadingEnabled()

virtual bool getSampleShadingEnabled ( ) const

pure virtual

Returns

if sample based shading is enabled

Implemented in RenderWindow, ColorDepthRenderTarget, RenderTarget, DepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

getWindingOrder()

virtual ECullWindingOrder getWindingOrder ( ) const

pure virtual

Returns

triangle winding order

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.

setClearColor()

virtual void setClearColor ( const RGBAColorFloat &  color )

pure virtual

Allows for setting the clear color

Implemented in RenderWindow, DepthRenderTarget, RenderTarget, ColorDepthRenderTarget, CubeRenderTarget, CubeDepthRenderTarget, and SnapshotRenderTarget.