CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::GPUImageSubresource Struct Referencefinal

Image subresource descriptor which specifies the array layer and MIP-map level range of a image resource. More...

#include <CeresEngine/RenderAPI/GPUImage.hpp>

Static Public Member Functions

template<typename Processor >
static constexpr void reflect (Processor &&RTTI)
 Executes the given processor for every field of the struct.
 

Public Attributes

UInt32 baseArrayLayer = 0
 Zero-based index of the first array layer.
 
UInt32 numArrayLayers = 1
 Number of array layers.
 
UInt32 baseMipLevel = 0
 MIP-map level for the sub-image, where 0 is the base image, and N > 0 is the N-th MIP-map level.
 
UInt32 numMipLevels = 1
 Number of MIP-map levels.
 

Friends

bool operator== (const GPUImageSubresource &lhs, const GPUImageSubresource &rhs)
 
bool operator!= (const GPUImageSubresource &lhs, const GPUImageSubresource &rhs)
 

Detailed Description

Image subresource descriptor which specifies the array layer and MIP-map level range of a image resource.

Remarks
The default values refer to the first array layer and the first MIP-map level.

Member Function Documentation

◆ reflect()

template<typename Processor >
static constexpr void CeresEngine::GPUImageSubresource::reflect ( Processor &&  RTTI)
inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters
RTTIThe processor to be ran for every field.

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ baseArrayLayer

UInt32 CeresEngine::GPUImageSubresource::baseArrayLayer = 0

Zero-based index of the first array layer.

By default 0.

Remarks
Only used by array image types (i.e. ImageType::Image1DArray, ImageType::Image2DArray, ImageType::ImageCubeArray, and ImageType::Image2DMSArray).
This field is ignored by all other image types.

◆ baseMipLevel

UInt32 CeresEngine::GPUImageSubresource::baseMipLevel = 0

MIP-map level for the sub-image, where 0 is the base image, and N > 0 is the N-th MIP-map level.

By default 0.

◆ numArrayLayers

UInt32 CeresEngine::GPUImageSubresource::numArrayLayers = 1

Number of array layers.

By default 1.

Remarks
If 0, will deduce the number of array layers based on the number of array layers in the source image.

◆ numMipLevels

UInt32 CeresEngine::GPUImageSubresource::numMipLevels = 1

Number of MIP-map levels.

By default 1.

Remarks
If 0, will deduce the number of mip levels based on the number of mips in the source image.

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