Texture creation parameters for 3D textures. More...

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

Inheritance diagram for kanzi::Texture::CreateInfo3D:

Public Member Functions
	CreateInfo3D (size_t sliceCount, BitmapImageUniquePtr image)
	CreateInfo3D constructor for texture creation parameters, for creating a 3D texture that is initialized from an image.

	CreateInfo3D (size_t width, size_t height, size_t depth, GraphicsFormat format)
	CreateInfo3D constructor for texture creation parameters, for creating a three dimensional texture with specified format and size.

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
	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 , StatusInvalidImageCount , StatusMissingImages , StatusImageMissingMipmaps , StatusInvalidImageSize , StatusInvalidMinimumSize , StatusInvalidMaximumSize , StatusInvalidMipmapSize , StatusUnsupportedGraphicsFormat , StatusUnsupportedTextureFilter , StatusInvalidFeatures , StatusUnsupportedMultisampleFilter , StatusUnsupportedMultisampleMipmaps , StatusUnsupportedMultisampleSamples , StatusUnsupportedRenderTargetSampleCount , StatusUnsupportedSampleCount , StatusImageFormatMismatch , StatusImageIncompatibleWithDevice , StatusUnsupportedDepthComparisonMode , StatusValid }
	Status tells if texture creation parameters can be used to create a texture. More...

enum class	Type { Image , Cubemap , Image3D , 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
	Depth for the base level of texture.

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.

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

Texture creation parameters for 3D textures.

Texture size, format and mipmap mode is determined from the images. You can use texture created with CreateInfo3D as content in materials for 3D rendering or material brushes.

Since: Kanzi 4.1.0

Constructor & Destructor Documentation

◆ CreateInfo3D() [1/2]

kanzi::Texture::CreateInfo3D::CreateInfo3D	(	size_t	sliceCount,
		BitmapImageUniquePtr	image )

explicit

CreateInfo3D constructor for texture creation parameters, for creating a 3D texture that is initialized from an image.

After the CreateInfo3D constructor:

Image is stored in create info.
Texture type is set to TypeThreeDimensional.
Texture size is set according to constructor parameters.
Texture format is determined from the image.

The following (from CreateInfo constructor) also applies:

Texture mipmap mode is set to MipmapModeBase, and mipmapLevelCount is set to 1, so texture will have only base image, no mipmaps.

Note: TextureTexture::create() takes ownership of images you pass in the create info,

See also: Texture::create().

Note: Source image height must be at least sliceHeight * sliceCount pixels high.

See also: Image

Parameters

sliceCount	Depth for the texture.
image	Source image for the texture.

◆ CreateInfo3D() [2/2]

kanzi::Texture::CreateInfo3D::CreateInfo3D	(	size_t	width,
		size_t	height,
		size_t	depth,
		GraphicsFormat	format )

explicit

CreateInfo3D constructor for texture creation parameters, for creating a three dimensional texture with specified format and size.