Castor3D 0.16.0
Multiplatform 3D engine
Fonctions membres publiques | Amis | Liste de tous les membres
Référence de la classe castor3d::TextureLayout

#include <TextureLayout.hpp>

Graphe d'héritage de castor3d::TextureLayout:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::TextureLayout:
Collaboration graph
[légende]

Fonctions membres publiques

C3D_API TextureLayout (RenderSystem &renderSystem, ashes::ImageCreateInfo info, VkMemoryPropertyFlags memoryProperties, castor::String const &debugName, bool isStatic=false)
 Constructeur.
 
C3D_API TextureLayout (RenderSystem &renderSystem, castor::String const &name, VkImage image, crg::ImageViewId imageView)
 Constructeur.
 
C3D_API TextureLayout (RenderSystem &renderSystem, ashes::ImagePtr image, VkImageCreateInfo const &createInfo)
 Constructeur.
 
C3D_API bool initialise (RenderDevice const &device)
 Initialise la texture et toutes ses vues.
 
C3D_API void upload (UploadData &uploader)
 Upload les données d'image dans le buffer de la texture.
 
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 const &cmd, VkImageLayout srcLayout=VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) const
 Génère les mipmaps de la texture.
 
Texture source setup.
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)
 
C3D_API void setSource (VkExtent3D const &extent, VkFormat format)
 
void setSource (VkExtent2D const &extent, VkFormat format)
 
Getters.
C3D_API castor::String getDefaultSourceString () const
 
C3D_API ashes::ImageView const & getDefaultSampledView () const noexcept
 
C3D_API ashes::ImageView const & getDefaultTargetView () const noexcept
 
C3D_API castor::String getLayerCubeSourceString (size_t layer) const noexcept
 
C3D_API ashes::ImageView const & getLayerCubeTargetView (size_t layer) const noexcept
 
C3D_API castor::String getLayerCubeFaceSourceString (size_t layer, CubeMapFace face) const noexcept
 
C3D_API ashes::ImageView const & getLayerCubeFaceTargetView (size_t layer, CubeMapFace face) const noexcept
 
C3D_API castor::String getName () const
 
C3D_API castor::Path getPath () const
 
C3D_API bool needsYInversion () const
 
C3D_API bool hasBuffer () const
 
uint32_t getLayersCount () const noexcept
 
uint32_t isCube () const noexcept
 
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 getMipLevels () const noexcept
 
VkExtent3D const & getDimensions () const noexcept
 
VkFormat getPixelFormat () const noexcept
 
- Fonctions membres publiques hérités de castor::OwnedBy< RenderSystem >
RenderSystem * getOwner () const
 L'objet propriétaire.
 

Amis

class TextureView
 

Membres hérités additionnels

- Fonctions membres protégées hérités de castor::OwnedBy< RenderSystem >
 OwnedBy (RenderSystem &owner)
 Constructeur.
 

Documentation des constructeurs et destructeur

◆ TextureLayout() [1/3]

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

Constructeur.

Paramètres
[in]renderSystemLe render system.
[in]infoLes informations de l'image.
[in]memoryPropertiesLes propriétés requise pour la mémoire.
[in]debugNameLe nom de debug pour ce layout.
[in]isStaticDit si ce layout est statique.

◆ TextureLayout() [2/3]

C3D_API castor3d::TextureLayout::TextureLayout ( RenderSystem & renderSystem,
castor::String const & name,
VkImage image,
crg::ImageViewId imageView )

Constructeur.

Paramètres
[in]renderSystemLe render system.
[in]nameLe nom de debug pour ce layout.
[in]imageL'image.
[in]imageViewLa vue sur l'image.

◆ TextureLayout() [3/3]

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

Constructeur.

Paramètres
[in]renderSystemLe render system.
[in]imageL'image.
[in]createInfoLes informations de l'image.

Documentation des fonctions membres

◆ cleanup()

C3D_API void castor3d::TextureLayout::cleanup ( )

Nettoie la texture et toutes ses vues.

◆ generateMipmaps() [1/3]

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

Génère les mipmaps de la texture.

Paramètres
[in]cmdLe command buffer recevant les commandes.
[in]srcLayoutLe 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]queueDataLa queue recevant les commandes GPU.
[in]srcLayoutLe 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]deviceLe device GPU.
[in]srcLayoutLe layout actuel de l'image.

◆ getCreateInfo()

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

◆ getDefaultSampledView()

C3D_API ashes::ImageView const & castor3d::TextureLayout::getDefaultSampledView ( ) const
noexcept

◆ getDefaultSourceString()

C3D_API castor::String castor3d::TextureLayout::getDefaultSourceString ( ) const

◆ getDefaultTargetView()

C3D_API ashes::ImageView const & castor3d::TextureLayout::getDefaultTargetView ( ) const
noexcept

◆ getDepth()

uint32_t castor3d::TextureLayout::getDepth ( ) const
inlinenoexcept

◆ 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

◆ getLayerCubeFaceSourceString()

C3D_API castor::String castor3d::TextureLayout::getLayerCubeFaceSourceString ( size_t layer,
CubeMapFace face ) const
noexcept

◆ getLayerCubeFaceTargetView()

C3D_API ashes::ImageView const & castor3d::TextureLayout::getLayerCubeFaceTargetView ( size_t layer,
CubeMapFace face ) const
noexcept

◆ getLayerCubeSourceString()

C3D_API castor::String castor3d::TextureLayout::getLayerCubeSourceString ( size_t layer) const
noexcept

◆ getLayerCubeTargetView()

C3D_API ashes::ImageView const & castor3d::TextureLayout::getLayerCubeTargetView ( size_t layer) const
noexcept

◆ getLayersCount()

uint32_t castor3d::TextureLayout::getLayersCount ( ) const
inlinenoexcept

Référencé par isCube().

Voici le graphe des appelants de cette fonction :

◆ getMipLevels()

uint32_t castor3d::TextureLayout::getMipLevels ( ) const
inlinenoexcept

◆ getName()

C3D_API castor::String castor3d::TextureLayout::getName ( ) const

◆ getPath()

C3D_API castor::Path castor3d::TextureLayout::getPath ( ) const

◆ getPixelFormat()

VkFormat castor3d::TextureLayout::getPixelFormat ( ) const
inlinenoexcept

◆ getTexture()

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

Références CU_Require.

◆ getType()

VkImageType castor3d::TextureLayout::getType ( ) const
inlinenoexcept

◆ getWidth()

uint32_t castor3d::TextureLayout::getWidth ( ) const
inlinenoexcept

◆ hasBuffer()

C3D_API bool castor3d::TextureLayout::hasBuffer ( ) const

◆ initialise()

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

Initialise la texture et toutes ses vues.

Paramètres
[in]deviceLe device GPU.
Renvoie
true si tout s'est bien passé.

◆ isCube()

uint32_t castor3d::TextureLayout::isCube ( ) const
inlinenoexcept

Références getLayersCount().

Voici le graphe d'appel pour cette fonction :

◆ isInitialised()

bool castor3d::TextureLayout::isInitialised ( ) const
inlinenoexcept

◆ isStatic()

bool castor3d::TextureLayout::isStatic ( ) const
inlinenoexcept

◆ needsYInversion()

C3D_API bool castor3d::TextureLayout::needsYInversion ( ) const

◆ setSource() [1/5]

C3D_API void castor3d::TextureLayout::setSource ( castor::Path const & folder,
castor::Path const & relative )

◆ 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 )

◆ upload()

C3D_API void castor3d::TextureLayout::upload ( UploadData & uploader)

Upload les données d'image dans le buffer de la texture.

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 :
Généré par doxygen 1.10.0