ezImageHeader Class Reference

A class containing image meta data, such as format and dimensions. More...

#include <ImageHeader.h>

Inheritance diagram for ezImageHeader:

Public Member Functions
	ezImageHeader ()
	Constructs an image using an unknown format and zero size.
void	Clear ()
	Constructs an image using an unknown format and zero size.
void	SetImageFormat (const ezImageFormat::Enum &format)
	Sets the image format.
ezImageFormat::Enum	GetImageFormat () const
	Returns the image format.
void	SetWidth (ezUInt32 uiWidth)
	Sets the image width.
ezUInt32	GetWidth (ezUInt32 uiMipLevel=0) const
	Returns the image width for a given mip level, clamped to 1.
void	SetHeight (ezUInt32 uiHeight)
	Sets the image height.
ezUInt32	GetHeight (ezUInt32 uiMipLevel=0) const
	Returns the image height for a given mip level, clamped to 1.
void	SetDepth (ezUInt32 uiDepth)
	Sets the image depth. The default is 1.
ezUInt32	GetDepth (ezUInt32 uiMipLevel=0) const
	Returns the image depth for a given mip level, clamped to 1.
void	SetNumMipLevels (ezUInt32 uiNumMipLevels)
	Sets the number of mip levels, including the full-size image. More...
ezUInt32	GetNumMipLevels () const
	Returns the number of mip levels, including the full-size image.
void	SetNumFaces (ezUInt32 uiNumFaces)
	Sets the number of cubemap faces. Use 1 for a non-cubemap. More...
ezUInt32	GetNumFaces () const
	Returns the number of cubemap faces, or 1 for a non-cubemap.
void	SetNumArrayIndices (ezUInt32 uiNumArrayIndices)
	Sets the number of array indices. More...
ezUInt32	GetNumArrayIndices () const
	Returns the number of array indices.
ezUInt32	GetPlaneCount () const
	Returns the number of image planes.
ezUInt32	GetNumBlocksX (ezUInt32 uiMipLevel=0, ezUInt32 uiPlaneIndex=0) const
	Returns the number of blocks contained in a given mip level in the horizontal direction.
ezUInt32	GetNumBlocksY (ezUInt32 uiMipLevel=0, ezUInt32 uiPlaneIndex=0) const
	Returns the number of blocks contained in a given mip level in the horizontal direction.
ezUInt32	GetNumBlocksZ (ezUInt32 uiMipLevel=0, ezUInt32 uiPlaneIndex=0) const
	Returns the number of blocks contained in a given mip level in the depth direction.
ezUInt64	GetRowPitch (ezUInt32 uiMipLevel=0, ezUInt32 uiPlaneIndex=0) const
	Returns the offset in bytes between two subsequent rows of the given mip level.
ezUInt64	GetDepthPitch (ezUInt32 uiMipLevel=0, ezUInt32 uiPlaneIndex=0) const
	Returns the offset in bytes between two subsequent depth slices of the given mip level.
ezUInt64	ComputeDataSize () const
	Computes the data size required for an image with the header's format and dimensions.
ezUInt32	ComputeNumberOfMipMaps () const
	Computes the number of mip maps in the full mip chain.
bool	operator== (const ezImageHeader &other) const
bool	operator!= (const ezImageHeader &other) const

Protected Attributes
ezUInt32	m_uiNumMipLevels
ezUInt32	m_uiNumFaces
ezUInt32	m_uiNumArrayIndices
ezUInt32	m_uiWidth
ezUInt32	m_uiHeight
ezUInt32	m_uiDepth
ezImageFormat::Enum	m_Format

Detailed Description

A class containing image meta data, such as format and dimensions.

This class has no associated behavior or functionality, and its getters and setters have no effect other than changing the contained value. It is intended as a container to be modified by image utils and loaders.

Member Function Documentation

SetNumArrayIndices()

void ezImageHeader::SetNumArrayIndices ( ezUInt32  uiNumArrayIndices )

inline

Sets the number of array indices.

Setting this to 0 will result in an empty image.

SetNumFaces()

void ezImageHeader::SetNumFaces ( ezUInt32  uiNumFaces )

inline

Sets the number of cubemap faces. Use 1 for a non-cubemap.

Setting this to 0 will result in an empty image.

SetNumMipLevels()

void ezImageHeader::SetNumMipLevels ( ezUInt32  uiNumMipLevels )

inline

Sets the number of mip levels, including the full-size image.

Setting this to 0 will result in an empty image.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Texture/Image/ImageHeader.h