kzu_render_target_base.h File Reference

Render target base definitions. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>

Typedefs
typedef kzsError(*	KzuRenderTargetBindFunction )(struct KzuRenderTarget *renderTarget, struct KzuRenderer *renderer, void *userData)
	Function definition for render target binding. More...
typedef kzsError(*	KzuRenderTargetUnbindFunction )(struct KzuRenderTarget *renderTarget, struct KzuRenderer *renderer, void *userData)
	Function definition for render target unbinding. More...
typedef void(*	KzuRenderTargetGetSizeFunction )(const struct KzuRenderTarget *renderTarget, void *userData, kzUint *out_width, kzUint *out_height)
	Function definition for querying render target size. More...

Functions
kzsError	kzuRenderTargetCreate_protected (const struct KzcMemoryManager *memoryManager, kzString name, KzuRenderTargetBindFunction bindFunction, KzuRenderTargetUnbindFunction unbindFunction, KzuRenderTargetGetSizeFunction getSizeFunction, void *userData, struct KzuRenderTarget **out_renderTarget)
	Creates a render target. More...
kzsError	kzuRenderTargetDelete_protected (struct KzuRenderTarget *renderTarget)
	Deletes a render target. More...

Detailed Description

Render target base definitions.

Copyright 2008-2019 by Rightware. All rights reserved.

Typedef Documentation

typedef kzsError(* KzuRenderTargetBindFunction)(struct KzuRenderTarget *renderTarget, struct KzuRenderer *renderer, void *userData)

Function definition for render target binding.

typedef kzsError(* KzuRenderTargetUnbindFunction)(struct KzuRenderTarget *renderTarget, struct KzuRenderer *renderer, void *userData)

Function definition for render target unbinding.

typedef void(* KzuRenderTargetGetSizeFunction)(const struct KzuRenderTarget *renderTarget, void *userData, kzUint *out_width, kzUint *out_height)

Function definition for querying render target size.

Function Documentation

kzsError kzuRenderTargetCreate_protected	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		KzuRenderTargetBindFunction	bindFunction,
		KzuRenderTargetUnbindFunction	unbindFunction,
		KzuRenderTargetGetSizeFunction	getSizeFunction,
		void *	userData,
		struct KzuRenderTarget **	out_renderTarget
	)

Creates a render target.

kzsError kzuRenderTargetDelete_protected

(

struct KzuRenderTarget *

renderTarget)

Deletes a render target.