Image view descriptor structure. 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
GPUImageType	type = GPUImageType::Image2D
	Hardware image type. By default ImageType::Image2D.

Format	format = Format::Undefined
	Hardware image format.

GPUImageSubresource	subresource
	Specifies the image subresource, i.e.

GPUImageSwizzleRGBA	swizzle
	Specifies the color component mapping.

String	name
	A user-facing name for the image view.

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

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

Detailed Description

Image view descriptor structure.

Remarks: Contains all information about type, format, and dimension to create a image view that shares the image data of another image.

Member Function Documentation

◆ reflect()

template<typename Processor >

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

friend

◆ operator==

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

friend

Member Data Documentation

◆ format

Format CeresEngine::GPUImageViewDescriptor::format = Format::Undefined

Hardware image format.

By default Format::Undefined. \remaks If set to Undefined, the system will try to deduce a sane value for the format based on the origin image.

◆ name

String CeresEngine::GPUImageViewDescriptor::name

A user-facing name for the image view.

This is only used for debugging.

◆ subresource

GPUImageSubresource CeresEngine::GPUImageViewDescriptor::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.

◆ swizzle

GPUImageSwizzleRGBA CeresEngine::GPUImageViewDescriptor::swizzle

Specifies the color component mapping.

Each component is mapped to its identity by default.

Remarks: If image swizzling is not supported, this must be equal to the default value.

Note: Only supported with: OpenGL, Vulkan, Metal, Direct3D 12.

◆ type

GPUImageType CeresEngine::GPUImageViewDescriptor::type = GPUImageType::Image2D

Hardware image type. By default ImageType::Image2D.

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