kzu_image_layer.h File Reference

Image layer class. More...

#include <user/scene_graph/kzu_object_base.h>
#include <system/kzs_header.h>

Functions
struct KzuImageLayer *	kzuImageLayerFromLayer (const struct KzuLayer *layer)
	Convert from layer to image layer. More...
struct KzuLayer *	kzuImageLayerToLayer (const struct KzuImageLayer *imageLayer)
	Convert from image layer to layer. More...
kzBool	kzuLayerIsImageLayer (const struct KzuLayer *layer)
	Returns KZ_TRUE if the layer is an image layer. More...
kzsError	kzuImageLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuImageLayer **out_imageLayer)
	Create an image layer. More...
kzsError	kzuImageLayerRegisterToFactory (const struct KzuFactory *factory)
	Register image layer to the factory. More...
struct KzuTexture *	kzuImageLayerGetTexture (const struct KzuImageLayer *layer)
	Return the texture of an image layer. More...
kzsError	kzuImageLayerSetTexture (struct KzuImageLayer *imageLayer, struct KzuTexture *texture)
	Set the texture for this image layer. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_IMAGE_LAYER
	Object type for image layers. More...

Detailed Description

Image layer class.

KzuImageLayer is used to display a texture.

Image Layer Messages

KzuImageLayer does not send or receive any messages.

Image Layer Properties

KZU_PROPERTY_TYPE_IMAGE_LAYER_TEXTURE string property specifies a resource ID for the texture to display. The kzuImageLayerSetTexture function can be used to override the texture set by this property.

Image Layer Example Code

The following code shows one way of displaying a PNG image with Kanzi.

kzsError result;
struct KzcImage* image;
struct KzuImageTexture* texture;
struct KzuImageLayer* imageLayer;

result = kzcImageLoadFileFlipped(memoryManager, "testImage.png", &image);
kzsErrorForward(result);

result = kzuImageTextureCreateFromImage(resourceManager, "image name", image, KZU_TEXTURE_FILTER_BILINEAR,
                                        KZU_TEXTURE_WRAP_CLAMP, 0.0f, &texture);
kzsErrorForward(result);

result = kzuImageLayerCreate(memoryManager, "image layer", uiDomain, &imageLayer);
kzsErrorForward(result);

result = kzuImageLayerSetTexture(imageLayer, kzuImageTextureToTexture(texture));
kzsErrorForward(result);

// Add imageLayer to a viewport such as the one returned by kzaApplicationGetRootLayer() to display the texture.
result = kzuObjectNodeAddChild(kzuLayerToObjectNode(rootLayer), kzuLayerToObjectNode(kzuImageLayerToLayer(imageLayer)));
kzsErrorForward(result);

// Do something else...

// Free texture and the image data.
result = kzuResourceRelease(kzuTextureToResource(kzuImageTextureToTexture(texture)));
kzsErrorForward(result);

// Destroy the image layer. 
result = kzuObjectNodeDelete(kzuLayerToObjectNode(kzuImageLayerToLayer(imageLayer)));
kzsErrorForward(result);

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

struct KzuImageLayer* kzuImageLayerFromLayer

(

const struct KzuLayer *

layer)

Convert from layer to image layer.

struct KzuLayer* kzuImageLayerToLayer

(

const struct KzuImageLayer *

imageLayer)

Convert from image layer to layer.

kzBool kzuLayerIsImageLayer

(

const struct KzuLayer *

layer)

Returns KZ_TRUE if the layer is an image layer.

Parameters

layer

The layer.

Returns

KZ_TRUE if the layer is an image layer, otherwise KZ_FALSE.

kzsError kzuImageLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuImageLayer **	out_imageLayer
	)

Create an image layer.

Parameters

memoryManager	Memory manager to use.
name	Name of the new image layer.
uiDomain	The UI domain.
out_imageLayer	A pointer that is set to point to the new image layer.

Returns

KZS_SUCCESS on success.

kzsError kzuImageLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Register image layer to the factory.

This is normally called from kzaApplicationCreate and needs to be done before calling any of the creation functions.

Parameters

factory

The factory to use.

Returns

KZS_SUCCESS on success.

struct KzuTexture* kzuImageLayerGetTexture

(

const struct KzuImageLayer *

layer)

Return the texture of an image layer.

Parameters

layer

The image layer.

Returns

The texture.

kzsError kzuImageLayerSetTexture	(	struct KzuImageLayer *	imageLayer,
		struct KzuTexture *	texture
	)

Set the texture for this image layer.

Parameters

imageLayer	The image layer.
texture	The texture resource.

Returns

KZS_SUCCESS on success.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_IMAGE_LAYER

Object type for image layers.