castor3d::PostEffectSurface Struct Reference

#include <PostEffectSurface.hpp>

Inheritance diagram for castor3d::PostEffectSurface:

Collaboration diagram for castor3d::PostEffectSurface:

Public Member Functions
C3D_API	PostEffectSurface (Engine &engine, castor::String debugName)
	Constructor. More...
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData, ashes::RenderPass const &renderPass, castor::Size const &size, VkFormat format=VK_FORMAT_R32G32B32A32_SFLOAT, uint32_t mipLevels=1u)
	Initialises the surface. More...
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData, ashes::RenderPass const &renderPass, castor::Size const &size, VkFormat colourFormat, VkFormat depthFormat)
	Initialises the surface. More...
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData, ashes::RenderPass const &renderPass, castor::Size const &size, TextureLayoutSPtr colourTexture)
	Initialises the surface. More...
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData, ashes::RenderPass const &renderPass, castor::Size const &size, TextureLayoutSPtr colourTexture, VkFormat depthFormat)
	Initialises the surface. More...
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData, ashes::RenderPass const &renderPass, castor::Size const &size, VkFormat colourFormat, TextureLayoutSPtr depthTexture)
	Initialises the surface. More...
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData, ashes::RenderPass const &renderPass, castor::Size const &size, TextureLayoutSPtr colourTexture, TextureLayoutSPtr depthTexture)
	Initialises the surface. More...
C3D_API void	cleanup (RenderDevice const &device)
	Cleans up the surface. More...

Public Attributes
ashes::FrameBufferPtr	frameBuffer
TextureLayoutSPtr	colourTexture
TextureLayoutSPtr	depthTexture
ashes::ImageView	depthView
ashes::ImageView	stencilView
castor::Size	size

Constructor & Destructor Documentation

PostEffectSurface()

C3D_API castor3d::PostEffectSurface::PostEffectSurface ( Engine &  engine, castor::String  debugName  )

explicit

Constructor.

Parameters

[in]	engine	The engine.
[in]	debugName	The surface debug name.

Member Function Documentation

cleanup()

C3D_API void castor3d::PostEffectSurface::cleanup

(

RenderDevice const &

device

)

Cleans up the surface.

Parameters

[in]

device

The GPU device.

initialise() [1/6]

C3D_API bool castor3d::PostEffectSurface::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData,
		ashes::RenderPass const &	renderPass,
		castor::Size const &	size,
		TextureLayoutSPtr	colourTexture
	)

Initialises the surface.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	renderPass	The render pass from which the frame buffer is created.
[in]	size	The surface's size.
[in]	colourTexture	The surface's colour texture.

initialise() [2/6]

C3D_API bool castor3d::PostEffectSurface::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData,
		ashes::RenderPass const &	renderPass,
		castor::Size const &	size,
		TextureLayoutSPtr	colourTexture,
		TextureLayoutSPtr	depthTexture
	)

Initialises the surface.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	renderPass	The render pass from which the frame buffer is created.
[in]	size	The surface's size.
[in]	colourTexture	The surface's colour texture.
[in]	depthTexture	The surface's depth texture.

initialise() [3/6]

C3D_API bool castor3d::PostEffectSurface::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData,
		ashes::RenderPass const &	renderPass,
		castor::Size const &	size,
		TextureLayoutSPtr	colourTexture,
		VkFormat	depthFormat
	)

Initialises the surface.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	renderPass	The render pass from which the frame buffer is created.
[in]	size	The surface's size.
[in]	colourTexture	The surface's colour texture.
[in]	depthFormat	The surface's depth pixel format.

initialise() [4/6]

C3D_API bool castor3d::PostEffectSurface::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData,
		ashes::RenderPass const &	renderPass,
		castor::Size const &	size,
		VkFormat	colourFormat,
		TextureLayoutSPtr	depthTexture
	)

Initialises the surface.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	renderPass	The render pass from which the frame buffer is created.
[in]	size	The surface's size.
[in]	colourFormat	The surface's colour pixel format.
[in]	depthTexture	The surface's depth texture.

initialise() [5/6]

C3D_API bool castor3d::PostEffectSurface::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData,
		ashes::RenderPass const &	renderPass,
		castor::Size const &	size,
		VkFormat	colourFormat,
		VkFormat	depthFormat
	)

Initialises the surface.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	renderPass	The render pass from which the frame buffer is created.
[in]	size	The surface's size.
[in]	colourFormat	The surface's colour pixel format.
[in]	depthFormat	The surface's depth pixel format.

initialise() [6/6]

C3D_API bool castor3d::PostEffectSurface::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData,
		ashes::RenderPass const &	renderPass,
		castor::Size const &	size,
		VkFormat	format = VK_FORMAT_R32G32B32A32_SFLOAT,
		uint32_t	mipLevels = 1u
	)

Initialises the surface.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	renderPass	The render pass from which the frame buffer is created.
[in]	size	The surface's size.
[in]	format	The surface's colour pixel format.
[in]	mipLevels	The surface's colour texture mipmap level.

Member Data Documentation

colourTexture

TextureLayoutSPtr castor3d::PostEffectSurface::colourTexture

The surface colour texture.

depthTexture

TextureLayoutSPtr castor3d::PostEffectSurface::depthTexture

The surface depth texture.

depthView

ashes::ImageView castor3d::PostEffectSurface::depthView

The surface depth view.

frameBuffer

ashes::FrameBufferPtr castor3d::PostEffectSurface::frameBuffer

The surface framebuffer.

size

castor::Size castor3d::PostEffectSurface::size

The surface dimensions.

stencilView

ashes::ImageView castor3d::PostEffectSurface::stencilView

The surface stencil view.

---

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

• Render/PostEffect/PostEffectSurface.hpp