kzu_render_target_texture.h File Reference

2D render target texture. More...

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

Functions
kzsError	kzuRenderTargetTextureCreate (const struct KzcMemoryManager *memoryManager, const struct KzuResourceManager *resourceManager, kzString name, struct KzuResourceLoader *loader, struct KzuRenderTargetTexture **out_renderTargetTexture)
	Creates a 2D render target texture that loads the data when needed using the given resource loader. More...
kzsError	kzuRenderTargetTextureRegisterToFactory (const struct KzuFactory *factory)
	Registers image texture type to factory. More...
kzsError	kzuRenderTargetTextureCreateFromMemory (const struct KzcMemoryManager *memoryManager, const struct KzuResourceManager *resourceManager, kzString name, enum KzuTextureDataType dataType, enum KzuTextureChannels channels, enum KzuTextureFilter filter, enum KzuTextureWrap wrap, kzUint width, kzUint height, kzBool depthRenderBuffer, kzBool stencilRenderBuffer, kzUint multisamples, struct KzuRenderTargetTexture **out_renderTargetTexture)
	Creates a 2D render target texture from memory. More...
kzsError	kzuRenderTargetTextureInitializeFromMemory (struct KzuRenderTargetTexture *renderTargetTexture, enum KzuTextureDataType dataType, enum KzuTextureChannels channels, enum KzuTextureFilter filter, enum KzuTextureWrap wrap, kzUint width, kzUint height, kzBool depthRenderBuffer, kzBool stencilRenderBuffer, kzUint multisamples)
	Initializes a render target texture with the given arguments. More...
struct KzuTexture *	kzuRenderTargetTextureToTexture (const struct KzuRenderTargetTexture *renderTargetTexture)
	Converts 2D render target texture to texture. More...
struct KzuRenderTargetTexture *	kzuRenderTargetTextureFromTexture (const struct KzuTexture *texture)
	Converts texture to 2D render target texture. More...
struct KzuGPUResource *	kzuRenderTargetTextureToGPUResource (const struct KzuRenderTargetTexture *renderTargetTexture)
	Converts 2D render target texture to GPU resource. More...
struct KzuRenderTargetTexture *	kzuRenderTargetTextureFromGPUResource (const struct KzuGPUResource *gpuResource)
	Converts GPU resource to 2D render target texture. More...
struct KzuResource *	kzuRenderTargetTextureToResource (const struct KzuRenderTargetTexture *renderTargetTexture)
	Converts 2D render target texture to resource. More...
struct KzuRenderTargetTexture *	kzuRenderTargetTextureFromResource (const struct KzuResource *resource)
	Converts resource to 2D render target texture. More...
kzBool	kzuRenderTargetTextureIsValid (const struct KzuRenderTargetTexture *renderTargetTexture)
	Returns if render target texture is valid after its deployment. More...
struct KzuRenderTarget *	kzuRenderTargetTextureGetRenderTarget (const struct KzuRenderTargetTexture *renderTargetTexture)
	Gets the render target of a 2D render target texture. More...
kzBool	kzuRenderTargetTextureHasDepthRenderBuffer (const struct KzuRenderTargetTexture *renderTargetTexture)
	Checks if the render target texture has depth render buffer. More...
kzBool	kzuRenderTargetTextureHasStencilRenderBuffer (const struct KzuRenderTargetTexture *renderTargetTexture)
	Checks if render target texture has stencil render buffer. More...
kzUint	kzuRenderTargetTextureGetFBOHandle (const struct KzuRenderTargetTexture *renderTargetTexture)
	Get the handle to the framebuffer object. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_RENDER_TARGET_TEXTURE
	Resource type identifier for 2D render target texture. More...

Detailed Description

2D render target texture.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuRenderTargetTextureCreate	(	const struct KzcMemoryManager *	memoryManager,
		const struct KzuResourceManager *	resourceManager,
		kzString	name,
		struct KzuResourceLoader *	loader,
		struct KzuRenderTargetTexture **	out_renderTargetTexture
	)

Creates a 2D render target texture that loads the data when needed using the given resource loader.

kzsError kzuRenderTargetTextureRegisterToFactory

(

const struct KzuFactory *

factory)

Registers image texture type to factory.

kzsError kzuRenderTargetTextureCreateFromMemory	(	const struct KzcMemoryManager *	memoryManager,
		const struct KzuResourceManager *	resourceManager,
		kzString	name,
		enum KzuTextureDataType	dataType,
		enum KzuTextureChannels	channels,
		enum KzuTextureFilter	filter,
		enum KzuTextureWrap	wrap,
		kzUint	width,
		kzUint	height,
		kzBool	depthRenderBuffer,
		kzBool	stencilRenderBuffer,
		kzUint	multisamples,
		struct KzuRenderTargetTexture **	out_renderTargetTexture
	)

Creates a 2D render target texture from memory.

kzsError kzuRenderTargetTextureInitializeFromMemory	(	struct KzuRenderTargetTexture *	renderTargetTexture,
		enum KzuTextureDataType	dataType,
		enum KzuTextureChannels	channels,
		enum KzuTextureFilter	filter,
		enum KzuTextureWrap	wrap,
		kzUint	width,
		kzUint	height,
		kzBool	depthRenderBuffer,
		kzBool	stencilRenderBuffer,
		kzUint	multisamples
	)

Initializes a render target texture with the given arguments.

Calling this function is safe only from a resource loader passed as an argument to kzuRenderTargetTextureCreate().

See Also

kzuRenderTargetTextureCreate for creating the render target texture.

struct KzuTexture* kzuRenderTargetTextureToTexture

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Converts 2D render target texture to texture.

struct KzuRenderTargetTexture* kzuRenderTargetTextureFromTexture

(

const struct KzuTexture *

texture)

Converts texture to 2D render target texture.

struct KzuGPUResource* kzuRenderTargetTextureToGPUResource

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Converts 2D render target texture to GPU resource.

struct KzuRenderTargetTexture* kzuRenderTargetTextureFromGPUResource

(

const struct KzuGPUResource *

gpuResource)

Converts GPU resource to 2D render target texture.

struct KzuResource* kzuRenderTargetTextureToResource

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Converts 2D render target texture to resource.

struct KzuRenderTargetTexture* kzuRenderTargetTextureFromResource

(

const struct KzuResource *

resource)

Converts resource to 2D render target texture.

kzBool kzuRenderTargetTextureIsValid

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Returns if render target texture is valid after its deployment.

struct KzuRenderTarget* kzuRenderTargetTextureGetRenderTarget

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Gets the render target of a 2D render target texture.

kzBool kzuRenderTargetTextureHasDepthRenderBuffer

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Checks if the render target texture has depth render buffer.

kzBool kzuRenderTargetTextureHasStencilRenderBuffer

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Checks if render target texture has stencil render buffer.

kzUint kzuRenderTargetTextureGetFBOHandle

(

const struct KzuRenderTargetTexture *

renderTargetTexture)

Get the handle to the framebuffer object.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_RENDER_TARGET_TEXTURE

Resource type identifier for 2D render target texture.