Référence de la structure castor::ImageLayout

#include <ImageLayout.hpp>

Types publics
enum	Type : uint8_t {   e1D = 0 , e2D = 1 , e3D = 2 , eCube = 3 ,   e1DArray = 4 , e2DArray = 5 , eCubeArray = 6 , Type_COUNT ,   Type_MIN = e1D }
using	Buffer = ByteArrayView
using	ConstBuffer = ConstByteArrayView
using	DeviceSize = uint64_t
using	SubresourceRange = Range< DeviceSize >

Fonctions membres publiques
	ImageLayout (Type type=e2D, PixelFormat format=PixelFormat::eR8G8B8A8_UNORM, Point3ui extent={ 1u, 1u, 1u }, uint32_t baseLayer=0u, uint32_t layers=1u, uint32_t baseLevel=0u, uint32_t levels=1u, uint32_t alignment=1u)
	ImageLayout (PxBufferBase const &buffer)
	ImageLayout (Type type, PxBufferBase const &buffer)
Size	dimensions () const noexcept
Size	dimensions (uint32_t level) const noexcept
uint32_t	depthLayers () const noexcept
CU_API SubresourceRange	range () const noexcept
CU_API SubresourceRange	slice (uint32_t index) const noexcept
CU_API SubresourceRange	sliceMip (uint32_t index, uint32_t level) const noexcept
CU_API DeviceSize	size () const noexcept
CU_API DeviceSize	sliceSize () const noexcept
CU_API DeviceSize	sliceMipSize (uint32_t level) const noexcept
CU_API DeviceSize	offset () const noexcept
CU_API DeviceSize	sliceOffset (uint32_t index) const noexcept
CU_API DeviceSize	sliceMipOffset (uint32_t index, uint32_t level) const noexcept
CU_API Buffer	buffer (PxBufferBase &buffer) const noexcept
CU_API Buffer	sliceBuffer (PxBufferBase &buffer, uint32_t index) const noexcept
CU_API Buffer	sliceMipBuffer (PxBufferBase &buffer, uint32_t index, uint32_t level) const noexcept
CU_API ConstBuffer	buffer (PxBufferBase const &buffer) const noexcept
CU_API ConstBuffer	sliceBuffer (PxBufferBase const &buffer, uint32_t index) const noexcept
CU_API ConstBuffer	sliceMipBuffer (PxBufferBase const &buffer, uint32_t index, uint32_t level) const noexcept
CU_API bool	hasBuffer (PxBufferBase const &buffer) const noexcept
CU_API bool	hasSliceBuffer (PxBufferBase const &buffer, uint32_t index) const noexcept
CU_API bool	hasSliceMipBuffer (PxBufferBase const &buffer, uint32_t index, uint32_t level) const noexcept
SubresourceRange	layer (uint32_t index) const noexcept
SubresourceRange	layerMip (uint32_t index, uint32_t level) const noexcept
DeviceSize	layerSize () const noexcept
DeviceSize	layerMipSize (uint32_t level) const noexcept
DeviceSize	layerOffset (uint32_t index) const noexcept
DeviceSize	layerMipOffset (uint32_t index, uint32_t level) const noexcept
Buffer	layerBuffer (PxBufferBase &buffer, uint32_t index) const noexcept
Buffer	layerMipBuffer (PxBufferBase &buffer, uint32_t index, uint32_t level) const noexcept
ConstBuffer	layerBuffer (PxBufferBase const &buffer, uint32_t index) const noexcept
ConstBuffer	layerMipBuffer (PxBufferBase const &buffer, uint32_t index, uint32_t level) const noexcept
bool	hasLayerBuffer (PxBufferBase const &buffer, uint32_t index) const noexcept
bool	hasLayerMipBuffer (PxBufferBase const &buffer, uint32_t index, uint32_t level) const noexcept

Fonctions membres publiques statiques
static StringView	getName (Type t)
static Type	getType (PxBufferBase const &buffer)

Attributs publics
Type	type
PixelFormat	format
Point3ui	extent
uint32_t	baseLayer
uint32_t	layers
uint32_t	baseLevel
uint32_t	levels
uint32_t	alignment

Documentation des définitions de type membres

Buffer

using castor::ImageLayout::Buffer = ByteArrayView

ConstBuffer

using castor::ImageLayout::ConstBuffer = ConstByteArrayView

DeviceSize

using castor::ImageLayout::DeviceSize = uint64_t

SubresourceRange

using castor::ImageLayout::SubresourceRange = Range< DeviceSize >

Documentation des énumérations membres

Type

enum castor::ImageLayout::Type : uint8_t

Valeurs énumérées
e1D
e2D
e3D
eCube
e1DArray
e2DArray
eCubeArray
Type_COUNT
Type_MIN

Documentation des constructeurs et destructeur

ImageLayout() [1/3]

castor::ImageLayout::ImageLayout ( Type type = e2D, PixelFormat format = PixelFormat::eR8G8B8A8_UNORM, Point3ui extent = { 1u, 1u, 1u }, uint32_t baseLayer = 0u, uint32_t layers = 1u, uint32_t baseLevel = 0u, uint32_t levels = 1u, uint32_t alignment = 1u )

inlineexplicit

ImageLayout() [2/3]

castor::ImageLayout::ImageLayout ( PxBufferBase const & buffer )

inlineexplicit

ImageLayout() [3/3]

castor::ImageLayout::ImageLayout ( Type type, PxBufferBase const & buffer )

inlineexplicit

Documentation des fonctions membres

buffer() [1/2]

CU_API Buffer castor::ImageLayout::buffer ( PxBufferBase & buffer ) const

noexcept

Référencé par castor3d::TextureSource::getBuffer(), castor3d::TextureSource::getBuffer(), castor::getBuffer(), castor::getBuffer(), getType(), hasLayerBuffer(), hasLayerMipBuffer(), layerBuffer(), layerBuffer(), layerMipBuffer(), et layerMipBuffer().

Voici le graphe des appelants de cette fonction :

buffer() [2/2]

CU_API ConstBuffer castor::ImageLayout::buffer ( PxBufferBase const & buffer ) const

noexcept

depthLayers()

uint32_t castor::ImageLayout::depthLayers ( ) const

inlinenoexcept

Références extent, et layers.

dimensions() [1/2]

Size castor::ImageLayout::dimensions ( ) const

inlinenoexcept

Références extent.

Référencé par dimensions().

Voici le graphe des appelants de cette fonction :

dimensions() [2/2]

Size castor::ImageLayout::dimensions ( uint32_t level ) const

inlinenoexcept

Références dimensions().

Voici le graphe d'appel pour cette fonction :

getName()

static StringView castor::ImageLayout::getName ( Type t )

inlinestatic

Références cuT, e1D, e1DArray, e2D, e2DArray, e3D, eCube, et eCubeArray.

getType()

static Type castor::ImageLayout::getType ( PxBufferBase const & buffer )

inlinestatic

Références buffer(), e1D, e1DArray, e2D, et e2DArray.

Voici le graphe d'appel pour cette fonction :

hasBuffer()

CU_API bool castor::ImageLayout::hasBuffer ( PxBufferBase const & buffer ) const

noexcept

Référencé par castor3d::TextureSource::hasBuffer().

Voici le graphe des appelants de cette fonction :

hasLayerBuffer()

bool castor::ImageLayout::hasLayerBuffer ( PxBufferBase const & buffer, uint32_t index ) const

inlinenoexcept

Références buffer(), et hasSliceBuffer().

Référencé par castor::hasLayerBuffer().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

hasLayerMipBuffer()

bool castor::ImageLayout::hasLayerMipBuffer ( PxBufferBase const & buffer, uint32_t index, uint32_t level ) const

inlinenoexcept

Références buffer(), et hasSliceMipBuffer().

Référencé par castor::hasLayerMipBuffer().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

hasSliceBuffer()

CU_API bool castor::ImageLayout::hasSliceBuffer ( PxBufferBase const & buffer, uint32_t index ) const

noexcept

Référencé par hasLayerBuffer(), et castor::hasSliceBuffer().

Voici le graphe des appelants de cette fonction :

hasSliceMipBuffer()

CU_API bool castor::ImageLayout::hasSliceMipBuffer ( PxBufferBase const & buffer, uint32_t index, uint32_t level ) const

noexcept

Référencé par hasLayerMipBuffer(), et castor::hasSliceMipBuffer().

Voici le graphe des appelants de cette fonction :

layer()

SubresourceRange castor::ImageLayout::layer ( uint32_t index ) const

inlinenoexcept

Références slice().

Voici le graphe d'appel pour cette fonction :

layerBuffer() [1/2]

Buffer castor::ImageLayout::layerBuffer ( PxBufferBase & buffer, uint32_t index ) const

inlinenoexcept

Références buffer(), et sliceBuffer().

Référencé par castor::getLayerBuffer(), et castor::getLayerBuffer().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

layerBuffer() [2/2]

ConstBuffer castor::ImageLayout::layerBuffer ( PxBufferBase const & buffer, uint32_t index ) const

inlinenoexcept

Références buffer(), et sliceBuffer().

Voici le graphe d'appel pour cette fonction :

layerMip()

SubresourceRange castor::ImageLayout::layerMip ( uint32_t index, uint32_t level ) const

inlinenoexcept

Références sliceMip().

Voici le graphe d'appel pour cette fonction :

layerMipBuffer() [1/2]

Buffer castor::ImageLayout::layerMipBuffer ( PxBufferBase & buffer, uint32_t index, uint32_t level ) const

inlinenoexcept

Références buffer(), et sliceMipBuffer().

Référencé par castor::getLayerMipBuffer(), et castor::getLayerMipBuffer().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

layerMipBuffer() [2/2]

ConstBuffer castor::ImageLayout::layerMipBuffer ( PxBufferBase const & buffer, uint32_t index, uint32_t level ) const

inlinenoexcept

Références buffer(), et sliceMipBuffer().

Voici le graphe d'appel pour cette fonction :

layerMipOffset()

DeviceSize castor::ImageLayout::layerMipOffset ( uint32_t index, uint32_t level ) const

inlinenoexcept

Références sliceMipOffset().

Référencé par castor::getLayerMipOffset().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

layerMipSize()

DeviceSize castor::ImageLayout::layerMipSize ( uint32_t level ) const

inlinenoexcept

Références sliceMipSize().

Référencé par castor::getLayerMipSize().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

layerOffset()

DeviceSize castor::ImageLayout::layerOffset ( uint32_t index ) const

inlinenoexcept

Références sliceOffset().

Référencé par castor::getLayerOffset().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

layerSize()

DeviceSize castor::ImageLayout::layerSize ( ) const

inlinenoexcept

Références sliceSize().

Référencé par castor::getLayerSize().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

offset()

CU_API DeviceSize castor::ImageLayout::offset ( ) const

noexcept

range()

CU_API SubresourceRange castor::ImageLayout::range ( ) const

noexcept

size()

CU_API DeviceSize castor::ImageLayout::size ( ) const

noexcept

slice()

CU_API SubresourceRange castor::ImageLayout::slice ( uint32_t index ) const

noexcept

Référencé par layer().

Voici le graphe des appelants de cette fonction :

sliceBuffer() [1/2]

CU_API Buffer castor::ImageLayout::sliceBuffer ( PxBufferBase & buffer, uint32_t index ) const

noexcept

Référencé par castor::getSliceBuffer(), castor::getSliceBuffer(), layerBuffer(), et layerBuffer().

Voici le graphe des appelants de cette fonction :

sliceBuffer() [2/2]

CU_API ConstBuffer castor::ImageLayout::sliceBuffer ( PxBufferBase const & buffer, uint32_t index ) const

noexcept

sliceMip()

CU_API SubresourceRange castor::ImageLayout::sliceMip ( uint32_t index, uint32_t level ) const

noexcept

Référencé par layerMip().

Voici le graphe des appelants de cette fonction :

sliceMipBuffer() [1/2]

CU_API Buffer castor::ImageLayout::sliceMipBuffer ( PxBufferBase & buffer, uint32_t index, uint32_t level ) const

noexcept

Référencé par castor::getSliceMipBuffer(), castor::getSliceMipBuffer(), layerMipBuffer(), et layerMipBuffer().

Voici le graphe des appelants de cette fonction :

sliceMipBuffer() [2/2]

CU_API ConstBuffer castor::ImageLayout::sliceMipBuffer ( PxBufferBase const & buffer, uint32_t index, uint32_t level ) const

noexcept

sliceMipOffset()

CU_API DeviceSize castor::ImageLayout::sliceMipOffset ( uint32_t index, uint32_t level ) const

noexcept

Référencé par castor::getSliceMipOffset(), et layerMipOffset().

Voici le graphe des appelants de cette fonction :

sliceMipSize()

CU_API DeviceSize castor::ImageLayout::sliceMipSize ( uint32_t level ) const

noexcept

Référencé par castor::getSliceMipSize(), et layerMipSize().

Voici le graphe des appelants de cette fonction :

sliceOffset()

CU_API DeviceSize castor::ImageLayout::sliceOffset ( uint32_t index ) const

noexcept

Référencé par castor::getSliceOffset(), et layerOffset().

Voici le graphe des appelants de cette fonction :

sliceSize()

CU_API DeviceSize castor::ImageLayout::sliceSize ( ) const

noexcept

Référencé par castor::getSliceSize(), et layerSize().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

alignment

uint32_t castor::ImageLayout::alignment

baseLayer

uint32_t castor::ImageLayout::baseLayer

Référencé par castor3d::TextureSource::getBaseLayer().

baseLevel

uint32_t castor::ImageLayout::baseLevel

Référencé par castor3d::TextureSource::getBaseLevel().

extent

Point3ui castor::ImageLayout::extent

Référencé par depthLayers(), dimensions(), castor3d::TextureSource::getDepth(), et castor3d::TextureSource::update().

format

PixelFormat castor::ImageLayout::format

Référencé par castor3d::TextureSource::update().

layers

uint32_t castor::ImageLayout::layers

Référencé par depthLayers(), castor3d::TextureSource::getLayerCount(), et castor3d::TextureSource::update().

levels

uint32_t castor::ImageLayout::levels

Référencé par castor3d::TextureSource::getLevelCount(), et castor3d::TextureSource::update().

type

Type castor::ImageLayout::type

---

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

• CastorUtils/Graphics/ImageLayout.hpp