Properties for a surface. More...

#include <kanzi/platform/context/kzs_surface_configuration.h>

Public Member Functions
	KzsSurfaceProperties ()
	Constructor.

Public Attributes
kzInt	antiAliasing
	Number of anti-aliasing samples used. Use 0 to turn AA off. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kzInt	bitsAlpha
	Size of alpha channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kzInt	bitsColorB
	Size of blue color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kzInt	bitsColorG
	Size of green color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kzInt	bitsColorR
	Size of red color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kzInt	bitsDepthBuffer
	Size of depth buffer in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kzInt	bitsPadding
	Size of padding in bits.

kzInt	bitsStencil
	Size of stencil buffer in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

kanzi::SurfaceClientAPI	clientAPI
	Graphics language for rendering on this surface.

kanzi::SurfaceColorSpace	colorSpace
	Color Space output by shaders.

kanzi::GraphicsContextAPI	contextAPI
	Graphics API for context.

kanzi::platform::PresentMode	presentMode

kzInt	priority
	Passes priority hint to surface creation. Won't be applied if set to KZS_SURFACE_PROPERTY_DONT_CARE.

kanzi::SwapBehavior	swapBehavior

Detailed Description

Properties for a surface.

Constructor & Destructor Documentation

◆ KzsSurfaceProperties()

KzsSurfaceProperties::KzsSurfaceProperties ( )

explicit

Constructor.

Member Data Documentation

◆ clientAPI

kanzi::SurfaceClientAPI KzsSurfaceProperties::clientAPI

Graphics language for rendering on this surface.

◆ contextAPI

kanzi::GraphicsContextAPI KzsSurfaceProperties::contextAPI

Graphics API for context.

◆ colorSpace

kanzi::SurfaceColorSpace KzsSurfaceProperties::colorSpace

Color Space output by shaders.

◆ bitsColorR

kzInt KzsSurfaceProperties::bitsColorR

Size of red color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ bitsColorG

kzInt KzsSurfaceProperties::bitsColorG

Size of green color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ bitsColorB

kzInt KzsSurfaceProperties::bitsColorB

Size of blue color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ bitsAlpha

kzInt KzsSurfaceProperties::bitsAlpha

Size of alpha channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ bitsPadding

kzInt KzsSurfaceProperties::bitsPadding

Size of padding in bits.

Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

Note: Most platforms don't support explicit definition of padding size.

◆ bitsStencil

kzInt KzsSurfaceProperties::bitsStencil

Size of stencil buffer in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ bitsDepthBuffer

kzInt KzsSurfaceProperties::bitsDepthBuffer

Size of depth buffer in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ antiAliasing

kzInt KzsSurfaceProperties::antiAliasing

Number of anti-aliasing samples used. Use 0 to turn AA off. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection.

◆ swapBehavior

kanzi::SwapBehavior KzsSurfaceProperties::swapBehavior

See also: SwapBehavior

◆ presentMode

kanzi::platform::PresentMode KzsSurfaceProperties::presentMode

See also: PresentMode

◆ priority

kzInt KzsSurfaceProperties::priority

Passes priority hint to surface creation. Won't be applied if set to KZS_SURFACE_PROPERTY_DONT_CARE.

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

kanzi/platform/context/kzs_surface_configuration.h

Public Member Functions

Public Attributes