Référence de la classe castor3d::TextureLayout

#include <TextureLayout.hpp>

Graphe d'héritage de castor3d::TextureLayout:

Graphe de collaboration de castor3d::TextureLayout:

Fonctions membres publiques
C3D_API	TextureLayout (RenderSystem &renderSystem, ashes::ImageCreateInfo info, VkMemoryPropertyFlags memoryProperties, castor::String debugName, bool isStatic=false)
	Constructeur.
C3D_API	TextureLayout (RenderSystem &renderSystem, VkImage image, crg::ImageViewId imageView)
	Constructeur.
C3D_API	TextureLayout (RenderSystem &renderSystem, ashes::ImagePtr image, VkImageCreateInfo const &createInfo)
	Constructeur.
C3D_API	~TextureLayout ()
	Destructeur.
C3D_API bool	initialise (RenderDevice const &device, QueueData const &queueData)
	Initialise la texture et toutes ses vues.
C3D_API void	cleanup ()
	Nettoie la texture et toutes ses vues.
C3D_API void	generateMipmaps (RenderDevice const &device, VkImageLayout srcLayout=VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) const
	Génère les mipmaps de la texture.
C3D_API void	generateMipmaps (QueueData const &queueData, VkImageLayout srcLayout=VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) const
	Génère les mipmaps de la texture.
C3D_API void	generateMipmaps (ashes::CommandBuffer &cmd, VkImageLayout srcLayout=VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) const
	Génère les mipmaps de la texture.
Whole texture access.
C3D_API void	setSource (castor::PxBufferBaseUPtr buffer, uint32_t bufferOrigLevels, bool isStatic=false)
	Définit la source de tout le layout.
C3D_API void	setSource (castor::PxBufferBaseUPtr buffer, bool isStatic=false)
C3D_API void	setSource (castor::Path const &folder, castor::Path const &relative, castor::ImageLoaderConfig config={ true, true, true })
C3D_API void	setSource (VkExtent3D const &extent, VkFormat format)
void	setSource (VkExtent2D const &extent, VkFormat format)
Getters.
TextureView const &	getDefaultView () const noexcept
TextureView &	getDefaultView () noexcept
MipView const &	getDefault () const noexcept
uint32_t	getLayersCount () const noexcept
ArrayView< MipView > const &	getArray2D () const noexcept
MipView const &	getLayer2D (size_t layer) const noexcept
MipView &	getLayer2D (size_t layer) noexcept
TextureView &	getLayer2DView (size_t layer) const noexcept
2D texture's mip level access.
TextureView &	getMipView (size_t level) const noexcept
Texture array's layer access.
C3D_API void	setLayerSource (uint32_t index, castor::PxBufferBaseUPtr buffer, uint32_t bufferOrigLevels)
	Définit la source pour tous les mip levels une couche du layout.
C3D_API void	setLayerSource (uint32_t index, castor::PxBufferBaseUPtr buffer)
C3D_API void	setLayerSource (uint32_t index, castor::Path const &folder, castor::Path const &relative, castor::ImageLoaderConfig config={ true, true, false })
C3D_API void	setLayerSource (uint32_t index, VkExtent3D const &extent, VkFormat format)
void	setLayerSource (uint32_t index, VkExtent2D const &extent, VkFormat format)
Texture array layer's mip level access.
C3D_API void	setLayerMipSource (uint32_t index, uint32_t level, castor::PxBufferBaseUPtr buffer)
	Définit la source pour un mip level d'une couche du layout.
C3D_API void	setLayerMipSource (uint32_t index, uint32_t level, castor::Path const &folder, castor::Path const &relative, castor::ImageLoaderConfig config={ true, false, false })
C3D_API void	setLayerMipSource (uint32_t index, uint32_t level, VkExtent3D const &extent, VkFormat format)
void	setLayerMipSource (uint32_t index, uint32_t level, VkExtent2D const &extent, VkFormat format)
3D texture's slice access.
SliceView< MipView > const &	getSlices3D () const noexcept
MipView const &	getSlice (size_t slice) const noexcept
MipView &	getSlice (size_t slice) noexcept
TextureView &	getSliceView (size_t slice) const noexcept
Cube array's texture access. Remarques A simple cube texture is a cube array of size 1.
uint32_t	isCube () const noexcept
ArrayView< CubeView > const &	getArrayCube () const noexcept
CubeView const &	getLayerCube (size_t layer) const noexcept
CubeView &	getLayerCube (size_t layer) noexcept
TextureView &	getLayerCubeView (size_t layer) const noexcept
Cube array texture layer's face access.
MipView const &	getLayerCubeFace (size_t layer, CubeMapFace face) const noexcept
MipView &	getLayerCubeFace (size_t layer, CubeMapFace face) noexcept
TextureView const &	getLayerCubeFaceView (size_t layer, CubeMapFace face) const noexcept
C3D_API void	setLayerCubeFaceSource (uint32_t layer, CubeMapFace face, castor::PxBufferBaseUPtr buffer)
	Définit la source pour une face d'un cube d'un tableau dans le layout.
C3D_API void	setLayerCubeFaceSource (uint32_t layer, CubeMapFace face, castor::Path const &folder, castor::Path const &relative, castor::ImageLoaderConfig config={ true, true, false })
void	setLayerCubeFaceSource (uint32_t layer, CubeMapFace face, VkExtent2D const &extent, VkFormat format)
Cube array texture layer face's mip level access.
TextureView &	getLayerCubeFaceMipView (size_t layer, CubeMapFace face, uint32_t level) const noexcept
C3D_API void	setLayerCubeFaceMipSource (uint32_t layer, CubeMapFace face, uint32_t level, castor::PxBufferBaseUPtr buffer)
	Définit la source pour un mip level d'une couche du layout.
C3D_API void	setLayerCubeFaceMipSource (uint32_t layer, CubeMapFace face, uint32_t level, castor::Path const &folder, castor::Path const &relative, castor::ImageLoaderConfig config={ true, false, false })
void	setLayerCubeFaceMipSource (uint32_t layer, CubeMapFace face, uint32_t level, VkExtent2D const &extent, VkFormat format)
C3D_API castor::String	getName () const
C3D_API castor::Path	getPath () const
C3D_API bool	needsYInversion () const
bool	isInitialised () const noexcept
bool	isStatic () const noexcept
VkImageType	getType () const noexcept
castor::Image const &	getImage () const noexcept
castor::Image &	getImage () noexcept
ashes::Image const &	getTexture () const noexcept
ashes::ImageCreateInfo const &	getCreateInfo () const noexcept
uint32_t	getWidth () const noexcept
uint32_t	getHeight () const noexcept
uint32_t	getDepth () const noexcept
uint32_t	getMipmapCount () const noexcept
VkExtent3D const &	getDimensions () const noexcept
VkFormat	getPixelFormat () const noexcept
template<typename FuncT >
void	forEachView (FuncT function) const
template<typename FuncT >
void	forEachFirstMipView (FuncT function) const
template<typename FuncT >
void	forEachLeafView (FuncT function) const

Amis
class	TextureView

Documentation des constructeurs et destructeur

TextureLayout() [1/3]

C3D_API castor3d::TextureLayout::TextureLayout	(	RenderSystem &	renderSystem,
		ashes::ImageCreateInfo	info,
		VkMemoryPropertyFlags	memoryProperties,
		castor::String	debugName,
		bool	isStatic = false
	)

Constructeur.

Paramètres

[in]	renderSystem	Le render system.
[in]	info	Les informations de l'image.
[in]	memoryProperties	Les propriétés requise pour la mémoire.
[in]	debugName	Le nom de debug pour ce layout.
[in]	isStatic	Dit si ce layout est statique.

TextureLayout() [2/3]

C3D_API castor3d::TextureLayout::TextureLayout	(	RenderSystem &	renderSystem,
		VkImage	image,
		crg::ImageViewId	imageView
	)

Constructeur.

Paramètres

[in]	renderSystem	Le render system.
[in]	image	L'image.
[in]	imageView	La vue sur l'image.

TextureLayout() [3/3]

C3D_API castor3d::TextureLayout::TextureLayout	(	RenderSystem &	renderSystem,
		ashes::ImagePtr	image,
		VkImageCreateInfo const &	createInfo
	)

Constructeur.

Paramètres

[in]	renderSystem	Le render system.
[in]	image	L'image.
[in]	createInfo	Les informations de l'image.

~TextureLayout()

C3D_API castor3d::TextureLayout::~TextureLayout

(

)

Destructeur.

Documentation des fonctions membres

cleanup()

C3D_API void castor3d::TextureLayout::cleanup

(

)

Nettoie la texture et toutes ses vues.

forEachFirstMipView()

template<typename FuncT >

void castor3d::TextureLayout::forEachFirstMipView ( FuncT  function ) const

inline

Références castor3d::MipView::forEachFirstMipView().

Voici le graphe d'appel pour cette fonction :

forEachLeafView()

template<typename FuncT >

void castor3d::TextureLayout::forEachLeafView ( FuncT  function ) const

inline

forEachView()

template<typename FuncT >

void castor3d::TextureLayout::forEachView ( FuncT  function ) const

inline

name Parsing des vues.

Références castor3d::MipView::forEachView().

Voici le graphe d'appel pour cette fonction :

generateMipmaps() [1/3]

C3D_API void castor3d::TextureLayout::generateMipmaps	(	ashes::CommandBuffer &	cmd,
		VkImageLayout	srcLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
	)		const

Génère les mipmaps de la texture.

Paramètres

[in]	cmd	Le command buffer recevant les commandes.
[in]	srcLayout	Le layout actuel de l'image.

generateMipmaps() [2/3]

C3D_API void castor3d::TextureLayout::generateMipmaps	(	QueueData const &	queueData,
		VkImageLayout	srcLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
	)		const

Génère les mipmaps de la texture.

Paramètres

[in]	queueData	La queue recevant les commandes GPU.
[in]	srcLayout	Le layout actuel de l'image.

generateMipmaps() [3/3]

C3D_API void castor3d::TextureLayout::generateMipmaps	(	RenderDevice const &	device,
		VkImageLayout	srcLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
	)		const

Génère les mipmaps de la texture.

Paramètres

[in]	device	Le device GPU.
[in]	srcLayout	Le layout actuel de l'image.

getArray2D()

ArrayView< MipView > const & castor3d::TextureLayout::getArray2D ( ) const

inlinenoexcept

getArrayCube()

ArrayView< CubeView > const & castor3d::TextureLayout::getArrayCube ( ) const

inlinenoexcept

getCreateInfo()

ashes::ImageCreateInfo const & castor3d::TextureLayout::getCreateInfo ( ) const

inlinenoexcept

getDefault()

MipView const & castor3d::TextureLayout::getDefault ( ) const

inlinenoexcept

Référencé par getMipView().

Voici le graphe des appelants de cette fonction :

getDefaultView() [1/2]

TextureView const & castor3d::TextureLayout::getDefaultView ( ) const

inlinenoexcept

Références castor3d::MipView::view.

getDefaultView() [2/2]

TextureView & castor3d::TextureLayout::getDefaultView ( )

inlinenoexcept

Références castor3d::MipView::view.

getDepth()

uint32_t castor3d::TextureLayout::getDepth ( ) const

inlinenoexcept

Référencé par getSlice().

Voici le graphe des appelants de cette fonction :

getDimensions()

VkExtent3D const & castor3d::TextureLayout::getDimensions ( ) const

inlinenoexcept

getHeight()

uint32_t castor3d::TextureLayout::getHeight ( ) const

inlinenoexcept

getImage() [1/2]

castor::Image const & castor3d::TextureLayout::getImage ( ) const

inlinenoexcept

getImage() [2/2]

castor::Image & castor3d::TextureLayout::getImage ( )

inlinenoexcept

getLayer2D() [1/2]

MipView const & castor3d::TextureLayout::getLayer2D ( size_t  layer ) const

inlinenoexcept

Références getLayersCount().

Référencé par getLayer2DView().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getLayer2D() [2/2]

MipView & castor3d::TextureLayout::getLayer2D ( size_t  layer )

inlinenoexcept

Références getLayersCount().

Voici le graphe d'appel pour cette fonction :

getLayer2DView()

TextureView & castor3d::TextureLayout::getLayer2DView ( size_t  layer ) const

inlinenoexcept

Références getLayer2D(), et castor3d::MipView::view.

Voici le graphe d'appel pour cette fonction :

getLayerCube() [1/2]

CubeView const & castor3d::TextureLayout::getLayerCube ( size_t  layer ) const

inlinenoexcept

Références isCube().

Référencé par getLayerCubeFace(), et getLayerCubeView().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getLayerCube() [2/2]

CubeView & castor3d::TextureLayout::getLayerCube ( size_t  layer )

inlinenoexcept

Références isCube().

Voici le graphe d'appel pour cette fonction :

getLayerCubeFace() [1/2]

MipView const & castor3d::TextureLayout::getLayerCubeFace ( size_t  layer, CubeMapFace  face  ) const

inlinenoexcept

Références castor3d::CubeView::faces, et getLayerCube().

Référencé par getLayerCubeFaceMipView(), et getLayerCubeFaceView().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getLayerCubeFace() [2/2]

MipView & castor3d::TextureLayout::getLayerCubeFace ( size_t  layer, CubeMapFace  face  )

inlinenoexcept

Références castor3d::CubeView::faces, et getLayerCube().

Voici le graphe d'appel pour cette fonction :

getLayerCubeFaceMipView()

TextureView & castor3d::TextureLayout::getLayerCubeFaceMipView ( size_t  layer, CubeMapFace  face, uint32_t  level  ) const

inlinenoexcept

Références getLayerCubeFace(), et castor3d::MipView::levels.

Voici le graphe d'appel pour cette fonction :

getLayerCubeFaceView()

TextureView const & castor3d::TextureLayout::getLayerCubeFaceView ( size_t  layer, CubeMapFace  face  ) const

inlinenoexcept

Références getLayerCubeFace(), et castor3d::MipView::view.

Voici le graphe d'appel pour cette fonction :

getLayerCubeView()

TextureView & castor3d::TextureLayout::getLayerCubeView ( size_t  layer ) const

inlinenoexcept

Références getLayerCube(), castor3d::MipView::view, et castor3d::CubeView::view.

Voici le graphe d'appel pour cette fonction :

getLayersCount()

uint32_t castor3d::TextureLayout::getLayersCount ( ) const

inlinenoexcept

Référencé par getLayer2D(), et isCube().

Voici le graphe des appelants de cette fonction :

getMipmapCount()

uint32_t castor3d::TextureLayout::getMipmapCount ( ) const

inlinenoexcept

getMipView()

TextureView & castor3d::TextureLayout::getMipView ( size_t  level ) const

inlinenoexcept

Références getDefault(), et castor3d::MipView::levels.

Voici le graphe d'appel pour cette fonction :

getName()

C3D_API castor::String castor3d::TextureLayout::getName

(

)

const

name Getters.

getPath()

C3D_API castor::Path castor3d::TextureLayout::getPath

(

)

const

getPixelFormat()

VkFormat castor3d::TextureLayout::getPixelFormat ( ) const

inlinenoexcept

getSlice() [1/2]

MipView const & castor3d::TextureLayout::getSlice ( size_t  slice ) const

inlinenoexcept

Références getDepth().

Référencé par getSliceView().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getSlice() [2/2]

MipView & castor3d::TextureLayout::getSlice ( size_t  slice )

inlinenoexcept

Références getDepth().

Voici le graphe d'appel pour cette fonction :

getSlices3D()

SliceView< MipView > const & castor3d::TextureLayout::getSlices3D ( ) const

inlinenoexcept

getSliceView()

TextureView & castor3d::TextureLayout::getSliceView ( size_t  slice ) const

inlinenoexcept

Références getSlice(), et castor3d::MipView::view.

Voici le graphe d'appel pour cette fonction :

getTexture()

ashes::Image const & castor3d::TextureLayout::getTexture ( ) const

inlinenoexcept

getType()

VkImageType castor3d::TextureLayout::getType ( ) const

inlinenoexcept

getWidth()

uint32_t castor3d::TextureLayout::getWidth ( ) const

inlinenoexcept

initialise()

C3D_API bool castor3d::TextureLayout::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData
	)

Initialise la texture et toutes ses vues.

Paramètres

[in]	device	Le device GPU.
[in]	queueData	La queue recevant les commandes GPU.

Renvoie

true si tout s'est bien passé.

isCube()

uint32_t castor3d::TextureLayout::isCube ( ) const

inlinenoexcept

Références getLayersCount().

Référencé par getLayerCube().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

isInitialised()

bool castor3d::TextureLayout::isInitialised ( ) const

inlinenoexcept

isStatic()

bool castor3d::TextureLayout::isStatic ( ) const

inlinenoexcept

needsYInversion()

C3D_API bool castor3d::TextureLayout::needsYInversion

(

)

const

setLayerCubeFaceMipSource() [1/3]

C3D_API void castor3d::TextureLayout::setLayerCubeFaceMipSource	(	uint32_t	layer,
		CubeMapFace	face,
		uint32_t	level,
		castor::Path const &	folder,
		castor::Path const &	relative,
		castor::ImageLoaderConfig	config = { true, false, false }
	)

setLayerCubeFaceMipSource() [2/3]

C3D_API void castor3d::TextureLayout::setLayerCubeFaceMipSource	(	uint32_t	layer,
		CubeMapFace	face,
		uint32_t	level,
		castor::PxBufferBaseUPtr	buffer
	)

Définit la source pour un mip level d'une couche du layout.

setLayerCubeFaceMipSource() [3/3]

void castor3d::TextureLayout::setLayerCubeFaceMipSource	(	uint32_t	layer,
		CubeMapFace	face,
		uint32_t	level,
		VkExtent2D const &	extent,
		VkFormat	format
	)

setLayerCubeFaceSource() [1/3]

C3D_API void castor3d::TextureLayout::setLayerCubeFaceSource	(	uint32_t	layer,
		CubeMapFace	face,
		castor::Path const &	folder,
		castor::Path const &	relative,
		castor::ImageLoaderConfig	config = { true, true, false }
	)

setLayerCubeFaceSource() [2/3]

C3D_API void castor3d::TextureLayout::setLayerCubeFaceSource	(	uint32_t	layer,
		CubeMapFace	face,
		castor::PxBufferBaseUPtr	buffer
	)

Définit la source pour une face d'un cube d'un tableau dans le layout.

setLayerCubeFaceSource() [3/3]

void castor3d::TextureLayout::setLayerCubeFaceSource	(	uint32_t	layer,
		CubeMapFace	face,
		VkExtent2D const &	extent,
		VkFormat	format
	)

setLayerMipSource() [1/4]

C3D_API void castor3d::TextureLayout::setLayerMipSource	(	uint32_t	index,
		uint32_t	level,
		castor::Path const &	folder,
		castor::Path const &	relative,
		castor::ImageLoaderConfig	config = { true, false, false }
	)

setLayerMipSource() [2/4]

C3D_API void castor3d::TextureLayout::setLayerMipSource	(	uint32_t	index,
		uint32_t	level,
		castor::PxBufferBaseUPtr	buffer
	)

Définit la source pour un mip level d'une couche du layout.

Référencé par setLayerMipSource().

Voici le graphe des appelants de cette fonction :

setLayerMipSource() [3/4]

void castor3d::TextureLayout::setLayerMipSource ( uint32_t  index, uint32_t  level, VkExtent2D const &  extent, VkFormat  format  )

inline

Références setLayerMipSource().

Voici le graphe d'appel pour cette fonction :

setLayerMipSource() [4/4]

C3D_API void castor3d::TextureLayout::setLayerMipSource	(	uint32_t	index,
		uint32_t	level,
		VkExtent3D const &	extent,
		VkFormat	format
	)

setLayerSource() [1/5]

C3D_API void castor3d::TextureLayout::setLayerSource	(	uint32_t	index,
		castor::Path const &	folder,
		castor::Path const &	relative,
		castor::ImageLoaderConfig	config = { true, true, false }
	)

setLayerSource() [2/5]

C3D_API void castor3d::TextureLayout::setLayerSource	(	uint32_t	index,
		castor::PxBufferBaseUPtr	buffer
	)

setLayerSource() [3/5]

C3D_API void castor3d::TextureLayout::setLayerSource	(	uint32_t	index,
		castor::PxBufferBaseUPtr	buffer,
		uint32_t	bufferOrigLevels
	)

Définit la source pour tous les mip levels une couche du layout.

Référencé par setLayerSource().

Voici le graphe des appelants de cette fonction :

setLayerSource() [4/5]

void castor3d::TextureLayout::setLayerSource ( uint32_t  index, VkExtent2D const &  extent, VkFormat  format  )

inline

Références setLayerSource().

Voici le graphe d'appel pour cette fonction :

setLayerSource() [5/5]

C3D_API void castor3d::TextureLayout::setLayerSource	(	uint32_t	index,
		VkExtent3D const &	extent,
		VkFormat	format
	)

setSource() [1/5]

C3D_API void castor3d::TextureLayout::setSource	(	castor::Path const &	folder,
		castor::Path const &	relative,
		castor::ImageLoaderConfig	config = { true, true, true }
	)

setSource() [2/5]

C3D_API void castor3d::TextureLayout::setSource	(	castor::PxBufferBaseUPtr	buffer,
		bool	isStatic = false
	)

setSource() [3/5]

C3D_API void castor3d::TextureLayout::setSource	(	castor::PxBufferBaseUPtr	buffer,
		uint32_t	bufferOrigLevels,
		bool	isStatic = false
	)

Définit la source de tout le layout.

Référencé par setSource().

Voici le graphe des appelants de cette fonction :

setSource() [4/5]

void castor3d::TextureLayout::setSource ( VkExtent2D const &  extent, VkFormat  format  )

inline

Références setSource().

Voici le graphe d'appel pour cette fonction :

setSource() [5/5]

C3D_API void castor3d::TextureLayout::setSource	(	VkExtent3D const &	extent,
		VkFormat	format
	)

Documentation des fonctions amies et associées

TextureView

friend class TextureView

friend

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Material/Texture/TextureLayout.hpp