Image location structure: MIP-map level and offset. 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
TOffset3< UInt32 >	offset = {0, 0, 0}
	Zero-based offset within the image data.

UInt32	arrayLayer = 0
	Zero-based array layer index.

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

Friends
bool	operator== (const GPUImageLocation &lhs, const GPUImageLocation &rhs)

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

Detailed Description

Image location structure: MIP-map level and offset.

Remarks: This is used to specify the source and destination location of a image copy operation.

Member Function Documentation

◆ reflect()

template<typename Processor >

static constexpr void CeresEngine::GPUImageLocation::reflect ( Processor && RTTI )

inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters

RTTI	The processor to be ran for every field.

Friends And Related Symbol Documentation

◆ operator!=

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

friend

◆ operator==

bool operator==	(	const GPUImageLocation &	lhs,
		const GPUImageLocation &	rhs
	)

friend

Member Data Documentation

◆ arrayLayer

UInt32 CeresEngine::GPUImageLocation::arrayLayer = 0

Zero-based array layer index.

Remarks: Only used by array image types (i.e. image1DArray, image2DArray, imageCubeArray, and image2DMSArray).; This field is ignored by all other image types.

◆ mipLevel

UInt32 CeresEngine::GPUImageLocation::mipLevel = 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.

◆ offset

TOffset3<UInt32> CeresEngine::GPUImageLocation::offset = {0, 0, 0}

Zero-based offset within the image data.

Remarks: Any component of this field that is not meant for the respective image type is ignored. All other components must be greater than or equal to zero.

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPUImage.hpp

Static Public Member Functions

Public Attributes

Friends