castor3d::TextureView Class Reference

#include <TextureView.hpp>

Inheritance diagram for castor3d::TextureView:

Collaboration diagram for castor3d::TextureView:

Public Member Functions
C3D_API	TextureView (TextureLayout &layout, ashes::ImageViewCreateInfo info, uint32_t index, castor::String debugName)
	Constructor.
C3D_API bool	initialise ()
	Initialises the view.
C3D_API void	update (VkImage image, uint32_t baseArrayLayer, uint32_t layerCount, uint32_t baseMipLevel, uint32_t levelCount)
	Updates the view range.
C3D_API void	update (VkExtent3D const &extent, VkFormat format, uint32_t mipLevels, uint32_t arrayLayers)
	Updates the view range.
C3D_API void	cleanup ()
	Cleans up the view.
Public Member Functions inherited from castor::OwnedBy< TextureLayout >
TextureLayout *	getOwner () const noexcept
void	setOwner (TextureLayout &owner) noexcept

Friends
class	TextureLayout
C3D_API castor::String	toString () const
C3D_API bool	hasBuffer () const
C3D_API castor::ImageLayout::ConstBuffer	getBuffer () const
C3D_API castor::ImageLayout::Buffer	getBuffer ()
C3D_API uint32_t	getLevelCount () const
C3D_API ashes::ImageView const &	getSampledView () const
C3D_API ashes::ImageView const &	getTargetView () const
uint32_t	getIndex () const
VkImageSubresourceRange const &	getSubresourceRange () const
uint32_t	getBaseMipLevel () const
void	setMipmapsGenerationNeeded (bool value)
bool	isMipmapsGenerationNeeded () const
bool	needsYInversion () const
bool	needsXInversion () const
bool	needsZInversion () const
static VkImageViewCreateInfo	convertToSampledView (VkImageViewCreateInfo createInfo)
static VkImageViewCreateInfo	convertToTargetView (VkImageViewCreateInfo createInfo, uint32_t depth)

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< TextureLayout >
	OwnedBy (TextureLayout &owner) noexcept
	Constructor.

Constructor & Destructor Documentation

TextureView()

C3D_API castor3d::TextureView::TextureView	(	TextureLayout &	layout,
		ashes::ImageViewCreateInfo	info,
		uint32_t	index,
		castor::String	debugName )

Constructor.

Parameters

[in]	layout	The parent layout.
[in]	info	The creation info.
[in]	index	The image index in its layout.
[in]	debugName	The debug name for this layout.

Member Function Documentation

cleanup()

C3D_API void castor3d::TextureView::cleanup

(

)

Cleans up the view.

convertToSampledView()

static VkImageViewCreateInfo castor3d::TextureView::convertToSampledView ( VkImageViewCreateInfo createInfo )

static

convertToTargetView()

static VkImageViewCreateInfo castor3d::TextureView::convertToTargetView ( VkImageViewCreateInfo createInfo, uint32_t depth )

static

getBaseMipLevel()

uint32_t castor3d::TextureView::getBaseMipLevel ( ) const

inline

getBuffer() [1/2]

C3D_API castor::ImageLayout::Buffer castor3d::TextureView::getBuffer

(

)

getBuffer() [2/2]

C3D_API castor::ImageLayout::ConstBuffer castor3d::TextureView::getBuffer

(

)

const

getIndex()

uint32_t castor3d::TextureView::getIndex ( ) const

inline

getLevelCount()

C3D_API uint32_t castor3d::TextureView::getLevelCount

(

)

const

getSampledView()

C3D_API ashes::ImageView const & castor3d::TextureView::getSampledView

(

)

const

getSubresourceRange()

VkImageSubresourceRange const & castor3d::TextureView::getSubresourceRange ( ) const

inline

getTargetView()

C3D_API ashes::ImageView const & castor3d::TextureView::getTargetView

(

)

const

hasBuffer()

C3D_API bool castor3d::TextureView::hasBuffer

(

)

const

initialise()

C3D_API bool castor3d::TextureView::initialise

(

)

Initialises the view.

Returns

true if inverted.

isMipmapsGenerationNeeded()

bool castor3d::TextureView::isMipmapsGenerationNeeded ( ) const

inline

needsXInversion()

bool castor3d::TextureView::needsXInversion ( ) const

inline

needsYInversion()

bool castor3d::TextureView::needsYInversion ( ) const

inline

needsZInversion()

bool castor3d::TextureView::needsZInversion ( ) const

inline

setMipmapsGenerationNeeded()

void castor3d::TextureView::setMipmapsGenerationNeeded ( bool value )

inline

toString()

C3D_API castor::String castor3d::TextureView::toString

(

)

const

name Getters.

update() [1/2]

C3D_API void castor3d::TextureView::update	(	VkExtent3D const &	extent,
		VkFormat	format,
		uint32_t	mipLevels,
		uint32_t	arrayLayers )

Updates the view range.

Parameters

[in]	extent	The extent.
[in]	format	The pixel format.
[in]	mipLevels	The miplevel count.
[in]	arrayLayers	The layer count.

update() [2/2]

C3D_API void castor3d::TextureView::update	(	VkImage	image,
		uint32_t	baseArrayLayer,
		uint32_t	layerCount,
		uint32_t	baseMipLevel,
		uint32_t	levelCount )

Updates the view range.

Parameters

[in]	image	The GPU image.
[in]	baseArrayLayer	The starting layer.
[in]	layerCount	The layer count.
[in]	baseMipLevel	The starting miplevel.
[in]	levelCount	The miplevel count.

Friends And Related Symbol Documentation

TextureLayout

friend class TextureLayout

friend

---

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

• Castor3D/Material/Texture/TextureView.hpp