Image region structure: Subresource (MIP-map level and array layer range), offset, and extent. 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
GPUImageSubresource	subresource
	Specifies the image subresource, i.e.

TOffset3< UInt32 >	offset = {0, 0, 0}
	Zero-based offset within the image data.

TExtent3< UInt32 >	extent = {0, 0, 0}
	Extent of the sub image region.

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

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

Detailed Description

Image region structure: Subresource (MIP-map level and array layer range), offset, and extent.

Remarks: This is used to write (or partially write) and read (or partially read) the image data of a single image MIP-map level.

Member Function Documentation

◆ reflect()

template<typename Processor >

static constexpr void CeresEngine::GPUImageRegion::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 GPUImageRegion &	lhs,
		const GPUImageRegion &	rhs
	)

friend

◆ operator==

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

friend

Member Data Documentation

◆ extent

TExtent3<UInt32> CeresEngine::GPUImageRegion::extent = {0, 0, 0}

Extent of the sub image region.

◆ offset

TOffset3<UInt32> CeresEngine::GPUImageRegion::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.

◆ subresource

GPUImageSubresource CeresEngine::GPUImageRegion::subresource

Specifies the image subresource, i.e.

MIP-map level and array layer range. By default only the first MIP-map level and first array layer is addressed.

Remarks: For image regions, numMipLevels of the ImageSubresource structure must always be 1, i.e. image regions can only select a single MIP-map at a time.

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