Kanzi  3.9.5
Kanzi Engine API
kzs_surface_configuration.h File Reference

Configuration for drawable surfaces and windows. More...

Classes

struct  kzsSurfaceConfigurationNativeFunctions
 
struct  KzsSurfaceProperties
 Properties for a surface. More...
 

Namespaces

 kanzi
 Easing functions that require external dependencies for calculation.
 

Macros

#define KZS_SURFACE_ATTRIBUTE_FORMAT_RGB_565
 RGB565 format. More...
 
#define KZS_SURFACE_ATTRIBUTE_FORMAT_RGBA_8888
 RGBA8888 format. More...
 
#define KZS_SURFACE_ATTRIBUTE_HEIGHT
 Height attribute. More...
 
#define KZS_SURFACE_ATTRIBUTE_IMAGE_PRESERVED
 Is image preserved over frames. More...
 
#define KZS_SURFACE_ATTRIBUTE_MATCH_FORMAT
 Match format (color format) attribute. More...
 
#define KZS_SURFACE_ATTRIBUTE_NONE
 Ends the array specification. More...
 
#define KZS_SURFACE_ATTRIBUTE_TEXTURE_LEVEL
 Texture level. More...
 
#define KZS_SURFACE_ATTRIBUTE_WIDTH
 Width attribute. More...
 
#define KZS_SURFACE_PROPERTY_DONT_CARE
 Indicates that the implementation can choose any value for a surface property. More...
 
#define KZS_SURFACE_TARGET_NATIVE_ANDROID
 Native android surface target. More...
 
#define KZS_SURFACE_TARGET_NATIVE_PIXMAP
 Native pixmap target. More...
 
#define KZS_SURFACE_TARGET_TEXTURE_2D
 Texture2D target. More...
 

Typedefs

typedef void(* kzsGLProcPointer) ()
 Pointer to GL function. More...
 
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. More...
 
typedef kzsError(* kzsSurfaceConfigurationNativeDestroyFunction) (struct KzsSurfaceConfigurationNative *configurationNative)
 Deletes a native surface configuration and frees all memory allocated for it. More...
 
typedef int(* kzsSurfaceConfigurationNativeGetPriorityFunction) (const struct KzsSurfaceConfigurationNative *configurationNative)
 Get priority. More...
 
typedef kanzi::SwapBehavior(* kzsSurfaceConfigurationNativeGetSwapBehavior) (const struct KzsSurfaceConfigurationNative *configurationNative)
 

Enumerations

enum  kanzi::GraphicsContextAPI { kanzi::GraphicsContextAPI::Unspecified, kanzi::GraphicsContextAPI::WGL, kanzi::GraphicsContextAPI::EGL, kanzi::GraphicsContextAPI::GLX }
 Graphics context API for a surface. More...
 
enum  kanzi::SurfaceClientAPI { kanzi::SurfaceClientAPI::Unspecified, kanzi::SurfaceClientAPI::OpenGLES, kanzi::SurfaceClientAPI::OpenVG, kanzi::SurfaceClientAPI::OpenGL }
 Client graphics API for a surface. More...
 
enum  kanzi::SwapBehavior { kanzi::SwapBehavior::Unspecified, kanzi::SwapBehavior::Copy, kanzi::SwapBehavior::Exchange }
 

Functions

kzsError kzsSurfaceConfigurationCreate (const struct KzsDesktop *desktop, const struct KzsSurfaceProperties *surfaceProperties, struct KzsSurfaceConfiguration **out_configuration)
 Creates a configuration for surfaces for a windows. More...
 
kzsError kzsSurfaceConfigurationDestroy (struct KzsSurfaceConfiguration *configuration)
 Deletes a surface configuration and frees all memory allocated for it. More...
 
kanzi::SurfaceColorSpace kzsSurfaceConfigurationGetColorSpace (const struct KzsSurfaceConfiguration *configuration)
 
kanzi::GraphicsContextAPI kzsSurfaceConfigurationGetContextAPI (const struct KzsSurfaceConfiguration *configuration)
 
const struct KzsSurfaceConfigurationNative * kzsSurfaceConfigurationGetNative (const struct KzsSurfaceConfiguration *configuration)
 Gets native portion of a surface configuration. More...
 
int kzsSurfaceConfigurationGetPriority (const struct KzsSurfaceConfiguration *configuration)
 Get priority. More...
 
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 default properties for surface. More...
 
kzsError kzsSurfacePropertiesLog (const struct KzsSurfaceProperties *properties, kzString prefix)
 Logs the surface properties with info log level. More...
 

Detailed Description

Configuration for drawable surfaces and windows.

Copyright 2008-2017 by Rightware. All rights reserved.

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)

Get priority.

◆ kzsSurfaceConfigurationNativeGetSwapBehavior

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

Function Documentation

◆ kzsSurfaceGetDefaultProperties()

struct KzsSurfaceProperties kzsSurfaceGetDefaultProperties ( void  )

Gets default properties for surface.

◆ 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 configuration for surfaces for a windows.

◆ 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 native portion of a surface configuration.

◆ kzsSurfaceConfigurationGetSwapBehavior()

kanzi::SwapBehavior kzsSurfaceConfigurationGetSwapBehavior ( const struct KzsSurfaceConfiguration configuration)

◆ kzsSurfaceConfigurationGetPriority()

int kzsSurfaceConfigurationGetPriority ( const struct KzsSurfaceConfiguration configuration)

Get priority.