kanzi::Texture::CreateInfoCubemapRenderTarget Struct Reference

Use Texture::CreateInfoCubemapRenderTarget to create a Cubemap Render Target Texture resource. More...

#include <kanzi/core.ui/graphics2d/texture_create_info.hpp>

Inheritance diagram for kanzi::Texture::CreateInfoCubemapRenderTarget:

Public Member Functions
	CreateInfoCubemapRenderTarget (GraphicsFormat format)
	Constructor.
Public Member Functions inherited from kanzi::Texture::CreateInfo
Status	adjust (const Renderer &renderer, string_view name)
	Validates and applies adjustments to some texture creation parameters in case of avoidable error conditions.
	CreateInfo ()=default
	Default constructor for texture create info.
int	getFeatures (const Renderer &renderer) const
	Gets the graphics format features required by this create info structure.
void	updateShapeAndFormatFromImages ()
	Use updateShapeAndFormatFromImages() to fill in format, width, height from images.
Status	validate (const Renderer &renderer) const
	Perform validation of texture creation parameters.
Status	validate (const Renderer &renderer, int features, string_view name) const
	Perform validation of texture creation parameters.
Status	validate (const Renderer &renderer, string_view name) const
	Perform validation of texture creation parameters.

Additional Inherited Members
Public Types inherited from kanzi::Texture::CreateInfo
enum	Status {   StatusInvalidType , StatusTypeNotSupported , StatusInvalidRenderTargetMode , StatusInvalidImageCount ,   StatusMissingImages , StatusImageMissingMipmaps , StatusInvalidImageSize , StatusInvalidMinimumSize ,   StatusInvalidMaximumSize , StatusInvalidMipmapSize , StatusUnsupportedGraphicsFormat , StatusUnsupportedTextureFilter ,   StatusInvalidFeatures , StatusUnsupportedMultisampleFilter , StatusUnsupportedMultisampleMipmaps , StatusUnsupportedMultisampleSamples ,   StatusUnsupportedInternalRenderTargetSampleCount , StatusUnsupportedSampleCount , StatusImageFormatMismatch , StatusImageIncompatibleWithDevice ,   StatusUnsupportedDepthComparisonMode , StatusValid }
	Status tells if texture creation parameters can be used to create a texture. More...
enum class	Type {   Image , Cubemap , RenderTarget , NativeImage ,   CubemapRenderTarget }
	Specifies the available texture types. More...
Static Public Member Functions inherited from kanzi::Texture::CreateInfo
static CreateInfo	createSubstitutePattern (const Renderer &renderer, TextureType type)
	Create a texture create info structure for a black 1x1 texture.
Public Attributes inherited from kanzi::Texture::CreateInfo
Sampler::AddressingMode	addressingMode
	Texture addressing mode.
float	anisotropy
	Texture anisotropy.
size_t	depth
	Reserved for future use.
GraphicsCompareFunction	depthCompareFunction
	Depth comparison function.
GraphicsFormat	depthStencilFormat
	DepthStencil format.
GraphicsFormat	format
	Format for texture.
size_t	height
	Height for the base level of texture.
unsigned int	heightDivisor
	Automatic size determination divisor for height, 0 when not automatic.
vector< BitmapImageSharedPtr >	images
	Images that are used to create the texture.
Sampler::Filter	magnificationFilter
	Texture minification filter.
float	maxLod
	Reserved for future use.
MemoryType	memoryType
	Memory type for the texture.
Sampler::Filter	minificationFilter
	Texture magnification filter.
float	minLod
	Reserved for future use.
float	mipLodBias
	Reserved for future use.
size_t	mipmapLevelCount
	Number of mipmap levels for the texture.
Sampler::MipmapMode	mipmapMode
	Mipmap mode for the texture.
NativeDeploymentTarget	nativeDeploymentTarget
	Native deployment target to use for memory storage if supported by the backend.
size_t	renderTargetSampleCount
	Specifies number of samples for the draw renderbuffer when RenderTargetMode is RenderTargetModeExternal.
bool	renderTargetTransient
	Indicates whether render target usage is transient.
TextureType	type
	Texture type.
gfx::ImageUsageFlag	usageFlags
	Usage for the texture.
size_t	width
	Width for the base level of texture.
unsigned int	widthDivisor
	Automatic size determination divisor for width, 0 when not automatic.
Protected Member Functions inherited from kanzi::Texture::CreateInfo
Status	validateFormat (const Renderer &renderer) const
	Validates texture format and features.
Status	validateImages (const Renderer &renderer, int features) const
	Test if given set of images can be used to create Texture.
Status	validateSize (const Renderer &renderer) const
	Validates texture size against minimum valid texture size (1x1) and maximum supported by graphics adapter.
Status	validateTargetCompatibility (const Renderer &renderer) const
	Checks for known device incompatibilities, for example with texture formats and size.

Detailed Description

Use Texture::CreateInfoCubemapRenderTarget to create a Cubemap Render Target Texture resource.

Since

Kanzi 3.9.8

Constructor & Destructor Documentation

CreateInfoCubemapRenderTarget()

kanzi::Texture::CreateInfoCubemapRenderTarget::CreateInfoCubemapRenderTarget ( GraphicsFormat format )

explicit

Constructor.

Parameters

format

The graphics format.

---

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

• kanzi/core.ui/graphics2d/texture_create_info.hpp