Configuration for drawable surfaces and windows. More...

#include <kanzi/core/legacy/debug/kzs_error.hpp>
#include <kanzi/core.ui/coreui_api.hpp>
#include <kanzi/core.ui/graphics/color_workflow.hpp>

Classes
struct	kzsSurfaceConfigurationNativeFunctions

struct	KzsSurfaceProperties
	Properties for a surface. More...

Namespaces
namespace	kanzi

Macros
#define	KZS_SURFACE_ATTRIBUTE_FORMAT_RGB_565
	RGB565 format.

#define	KZS_SURFACE_ATTRIBUTE_FORMAT_RGBA_8888
	RGBA8888 format.

#define	KZS_SURFACE_ATTRIBUTE_HEIGHT
	Height attribute.

#define	KZS_SURFACE_ATTRIBUTE_IMAGE_PRESERVED
	Is image preserved over frames.

#define	KZS_SURFACE_ATTRIBUTE_MATCH_FORMAT
	Match format (color format) attribute.

#define	KZS_SURFACE_ATTRIBUTE_NONE
	Ends the array specification.

#define	KZS_SURFACE_ATTRIBUTE_TEXTURE_LEVEL
	Texture level.

#define	KZS_SURFACE_ATTRIBUTE_WIDTH
	Width attribute.

#define	KZS_SURFACE_PROPERTY_DONT_CARE
	Indicates that the implementation can choose any value for a surface property.

#define	KZS_SURFACE_TARGET_NATIVE_ANDROID
	Native android surface target.

#define	KZS_SURFACE_TARGET_NATIVE_PIXMAP
	Native pixmap target.

#define	KZS_SURFACE_TARGET_TEXTURE_2D
	Texture2D target.

Typedefs
typedef void(*	kzsGLProcPointer) ()
	Pointer to GL function.

typedef kzsError(*	kzsSurfaceConfigurationGetSurfaceNativeFunctionsFunction) (const struct KzsSurfaceConfigurationNative configurationNative, struct kzsSurfaceNativeFunctions functions)

typedef kzsError(*	kzsSurfaceConfigurationNativeCreateFunction) (const struct KzsDesktop desktop, const struct KzsSurfaceProperties surfaceProperties, struct KzsSurfaceConfigurationNative **out_configurationNative)
	Creates a native surface configuration.

typedef kzsError(*	kzsSurfaceConfigurationNativeDestroyFunction) (struct KzsSurfaceConfigurationNative *configurationNative)
	Deletes a native surface configuration and frees all memory allocated for it.

typedef int(*	kzsSurfaceConfigurationNativeGetPriorityFunction) (const struct KzsSurfaceConfigurationNative *configurationNative)
	Gets the priority.

typedef kanzi::SwapBehavior(*	kzsSurfaceConfigurationNativeGetSwapBehavior) (const struct KzsSurfaceConfigurationNative *configurationNative)

Enumerations
enum class	kanzi::GraphicsContextAPI { kanzi::Unspecified , kanzi::WGL , kanzi::EGL , kanzi::GLX }
	Graphics context API for a surface. More...

enum class	kanzi::SurfaceClientAPI { kanzi::Unspecified , kanzi::OpenGLES , kanzi::OpenVG , kanzi::OpenGL }
	Client graphics API for a surface. More...

enum class	kanzi::SwapBehavior { kanzi::Unspecified , kanzi::Copy , kanzi::Exchange }

Functions
kzsError	kzsSurfaceConfigurationCreate (const struct KzsDesktop desktop, const struct KzsSurfaceProperties surfaceProperties, struct KzsSurfaceConfiguration **out_configuration)
	Creates a surface configuration for a window.

kzsError	kzsSurfaceConfigurationDestroy (struct KzsSurfaceConfiguration *configuration)
	Deletes a surface configuration and frees all memory allocated for it.

kanzi::SurfaceColorSpace	kzsSurfaceConfigurationGetColorSpace (const struct KzsSurfaceConfiguration *configuration)

kanzi::GraphicsContextAPI	kzsSurfaceConfigurationGetContextAPI (const struct KzsSurfaceConfiguration *configuration)

const struct KzsSurfaceConfigurationNative *	kzsSurfaceConfigurationGetNative (const struct KzsSurfaceConfiguration *configuration)
	Gets the native portion of a surface configuration.

int	kzsSurfaceConfigurationGetPriority (const struct KzsSurfaceConfiguration *configuration)
	Gets the priority.

kanzi::SurfaceClientAPI	kzsSurfaceConfigurationGetSurfaceClientAPI (const struct KzsSurfaceConfiguration *configuration)

kzsError	kzsSurfaceConfigurationGetSurfaceNativeFunctions (const struct KzsSurfaceConfiguration configuration, struct kzsSurfaceNativeFunctions functions)

kanzi::SwapBehavior	kzsSurfaceConfigurationGetSwapBehavior (const struct KzsSurfaceConfiguration *configuration)

struct KzsSurfaceProperties	kzsSurfaceGetDefaultProperties (void)
	Gets the platform-dependent default values of surface properties.

kzsError	kzsSurfacePropertiesLog (const struct KzsSurfaceProperties *properties, kzString prefix)
	Logs the surface properties with info log level.

Detailed Description

Configuration for drawable surfaces and windows.

Macro Definition Documentation

◆ KZS_SURFACE_PROPERTY_DONT_CARE

#define KZS_SURFACE_PROPERTY_DONT_CARE

Indicates that the implementation can choose any value for a surface property.

◆ KZS_SURFACE_TARGET_NATIVE_ANDROID

#define KZS_SURFACE_TARGET_NATIVE_ANDROID

Native android surface target.

◆ KZS_SURFACE_TARGET_NATIVE_PIXMAP

#define KZS_SURFACE_TARGET_NATIVE_PIXMAP

Native pixmap target.

◆ KZS_SURFACE_TARGET_TEXTURE_2D

#define KZS_SURFACE_TARGET_TEXTURE_2D

Texture2D target.

◆ KZS_SURFACE_ATTRIBUTE_WIDTH

#define KZS_SURFACE_ATTRIBUTE_WIDTH

Width attribute.

◆ KZS_SURFACE_ATTRIBUTE_HEIGHT

#define KZS_SURFACE_ATTRIBUTE_HEIGHT

Height attribute.

◆ KZS_SURFACE_ATTRIBUTE_MATCH_FORMAT

#define KZS_SURFACE_ATTRIBUTE_MATCH_FORMAT

Match format (color format) attribute.

◆ KZS_SURFACE_ATTRIBUTE_IMAGE_PRESERVED

#define KZS_SURFACE_ATTRIBUTE_IMAGE_PRESERVED

Is image preserved over frames.

◆ KZS_SURFACE_ATTRIBUTE_NONE

#define KZS_SURFACE_ATTRIBUTE_NONE

Ends the array specification.

◆ KZS_SURFACE_ATTRIBUTE_FORMAT_RGBA_8888

#define KZS_SURFACE_ATTRIBUTE_FORMAT_RGBA_8888

RGBA8888 format.

◆ KZS_SURFACE_ATTRIBUTE_FORMAT_RGB_565

#define KZS_SURFACE_ATTRIBUTE_FORMAT_RGB_565

RGB565 format.

◆ KZS_SURFACE_ATTRIBUTE_TEXTURE_LEVEL

#define KZS_SURFACE_ATTRIBUTE_TEXTURE_LEVEL

Texture level.

Typedef Documentation

◆ kzsGLProcPointer

typedef void(* kzsGLProcPointer) ()

Pointer to GL function.

◆ kzsSurfaceConfigurationGetSurfaceNativeFunctionsFunction

typedef kzsError(* kzsSurfaceConfigurationGetSurfaceNativeFunctionsFunction) (const struct KzsSurfaceConfigurationNative *configurationNative, struct kzsSurfaceNativeFunctions *functions)

◆ kzsSurfaceConfigurationNativeCreateFunction

typedef kzsError(* kzsSurfaceConfigurationNativeCreateFunction) (const struct KzsDesktop *desktop, const struct KzsSurfaceProperties *surfaceProperties, struct KzsSurfaceConfigurationNative **out_configurationNative)

Creates a native surface configuration.

◆ kzsSurfaceConfigurationNativeDestroyFunction

typedef kzsError(* kzsSurfaceConfigurationNativeDestroyFunction) (struct KzsSurfaceConfigurationNative *configurationNative)

Deletes a native surface configuration and frees all memory allocated for it.

◆ kzsSurfaceConfigurationNativeGetPriorityFunction

typedef int(* kzsSurfaceConfigurationNativeGetPriorityFunction) (const struct KzsSurfaceConfigurationNative *configurationNative)

Gets the priority.

◆ kzsSurfaceConfigurationNativeGetSwapBehavior

typedef kanzi::SwapBehavior(* kzsSurfaceConfigurationNativeGetSwapBehavior) (const struct KzsSurfaceConfigurationNative *configurationNative)

Function Documentation

◆ kzsSurfaceGetDefaultProperties()

struct KzsSurfaceProperties kzsSurfaceGetDefaultProperties ( void )

Gets the platform-dependent default values of surface properties.

◆ kzsSurfacePropertiesLog()

kzsError kzsSurfacePropertiesLog	(	const struct KzsSurfaceProperties *	properties,
		kzString	prefix )

Logs the surface properties with info log level.

◆ kzsSurfaceConfigurationCreate()

kzsError kzsSurfaceConfigurationCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsSurfaceProperties *	surfaceProperties,
		struct KzsSurfaceConfiguration **	out_configuration )

Creates a surface configuration for a window.

◆ kzsSurfaceConfigurationDestroy()

kzsError kzsSurfaceConfigurationDestroy ( struct KzsSurfaceConfiguration * configuration )

Deletes a surface configuration and frees all memory allocated for it.

◆ kzsSurfaceConfigurationGetSurfaceNativeFunctions()

kzsError kzsSurfaceConfigurationGetSurfaceNativeFunctions	(	const struct KzsSurfaceConfiguration *	configuration,
		struct kzsSurfaceNativeFunctions *	functions )

◆ kzsSurfaceConfigurationGetSurfaceClientAPI()

kanzi::SurfaceClientAPI kzsSurfaceConfigurationGetSurfaceClientAPI ( const struct KzsSurfaceConfiguration * configuration )

◆ kzsSurfaceConfigurationGetColorSpace()

kanzi::SurfaceColorSpace kzsSurfaceConfigurationGetColorSpace ( const struct KzsSurfaceConfiguration * configuration )

◆ kzsSurfaceConfigurationGetContextAPI()

kanzi::GraphicsContextAPI kzsSurfaceConfigurationGetContextAPI ( const struct KzsSurfaceConfiguration * configuration )

◆ kzsSurfaceConfigurationGetNative()

const struct KzsSurfaceConfigurationNative * kzsSurfaceConfigurationGetNative ( const struct KzsSurfaceConfiguration * configuration )

Gets the native portion of a surface configuration.

◆ kzsSurfaceConfigurationGetSwapBehavior()

kanzi::SwapBehavior kzsSurfaceConfigurationGetSwapBehavior ( const struct KzsSurfaceConfiguration * configuration )

◆ kzsSurfaceConfigurationGetPriority()

int kzsSurfaceConfigurationGetPriority ( const struct KzsSurfaceConfiguration * configuration )