Public Member Functions | Public Attributes | List of all members
KzsSurfaceProperties Struct Reference

Properties for a surface. More...

#include <kanzi/core.ui/platform/graphics_context/common/kzs_surface_configuration.h>

Public Member Functions

 KzsSurfaceProperties ()
 Constructor. More...
 

Public Attributes

enum KzsSurfaceType type
 Graphics language for rendering on this surface. More...
 
enum KzsGraphicsContextAPI contextApi
 Graphics API for context. More...
 
kzInt bitsColorR
 Size of red color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
kzInt bitsColorG
 Size of green color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
kzInt bitsColorB
 Size of blue color channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
kzInt bitsAlpha
 Size of alpha channel in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
kzInt bitsPadding
 Size of padding in bits. More...
 
kzInt bitsStencil
 Size of stencil buffer in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
kzInt bitsDepthBuffer
 Size of depth buffer in bits. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
kzInt antiAliasing
 Number of anti-aliasing samples used. Use 0 to turn AA off. Set to KZS_SURFACE_PROPERTY_DONT_CARE for automatic selection. More...
 
KzsSwapBehavior swapBehavior
 
kzInt priority
 Passes priority hint to surface creation. Won't be applied if set to KZS_SURFACE_PROPERTY_DONT_CARE. More...
 

Detailed Description

Properties for a surface.

Constructor & Destructor Documentation

KzsSurfaceProperties::KzsSurfaceProperties ( )
explicit

Constructor.

Member Data Documentation

enum KzsSurfaceType KzsSurfaceProperties::type

Graphics language for rendering on this surface.

enum KzsGraphicsContextAPI KzsSurfaceProperties::contextApi

Graphics API for context.

kzInt KzsSurfaceProperties::bitsColorR

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

kzInt KzsSurfaceProperties::bitsColorG

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

kzInt KzsSurfaceProperties::bitsColorB

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

kzInt KzsSurfaceProperties::bitsAlpha

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

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.
kzInt KzsSurfaceProperties::bitsStencil

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

kzInt KzsSurfaceProperties::bitsDepthBuffer

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

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.

KzsSwapBehavior KzsSurfaceProperties::swapBehavior
See also
SwapBehavior
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: