lib/writer.c File Reference

Functions for creating KTX-format files from a set of images. More...

#include <stdio.h>
#include <assert.h>
#include "ktx.h"
#include "ktxint.h"

Functions
KTX_error_code	ktxWriteKTXF (FILE *dst, const KTX_texture_info *textureInfo, GLsizei bytesOfKeyValueData, const void *keyValueData, GLuint numImages, KTX_image_info images[])
	Write image(s) in a KTX-formatted stdio FILE stream.
KTX_error_code	ktxWriteKTXN (const char *dstname, const KTX_texture_info *textureInfo, GLsizei bytesOfKeyValueData, const void *keyValueData, GLuint numImages, KTX_image_info images[])
	Write image(s) to a KTX file on disk.

---

Detailed Description

Functions for creating KTX-format files from a set of images.

Author:

Mark Callow, HI Corporation

Revision:

21679

Date:

2013-05-22 19:03:13 +0900 #

---

Function Documentation

KTX_error_code ktxWriteKTXF	(	FILE *	dst,
		const KTX_texture_info *	textureInfo,
		GLsizei	bytesOfKeyValueData,
		const void *	keyValueData,
		GLuint	numImages,
		KTX_image_info	images[]
	)

Write image(s) in a KTX-formatted stdio FILE stream.

Parameters:

[in]	dst	pointer to the FILE stream to write to.
[in]	textureInfo	pointer to a KTX_image_info structure providing information about the images to be included in the KTX file.
[in]	bytesOfKeyValueData	specifies the number of bytes of key-value data.
[in]	keyValueData	a pointer to the keyValue data.
[in]	numImages	number of images in the following array
[in]	images	array of KTX_image_info providing image size and data.

Returns:

KTX_SUCCESS on success, other KTX_* enum values on error.

Exceptions:

KTX_INVALID_VALUE	dst or target are NULL
KTX_INVALID_VALUE	glTypeSize in textureInfo is not 1, 2, or 4 or is different from the size of the type specified in glType.
KTX_INVALID_VALUE	pixelWidth in textureInfo is 0 or pixelDepth != 0 && pixelHeight == 0.
KTX_INVALID_VALUE	numberOfFaces != 1 || numberOfFaces != 6 or numberOfArrayElements or numberOfMipmapLevels are < 0.
KTX_INVALID_OPERATION	numberOfFaces == 6 and images are either not 2D or are not square.
KTX_INVALID_OPERATION	number of images is insufficient for the specified number of mipmap levels and faces.
KTX_INVALID_OPERATION	the size of a provided image is different than that required for the specified width, height or depth or for the mipmap level being processed.
KTX_FILE_WRITE_ERROR	a system error occurred while writing the file.

KTX_error_code ktxWriteKTXN	(	const char *	dstname,
		const KTX_texture_info *	textureInfo,
		GLsizei	bytesOfKeyValueData,
		const void *	keyValueData,
		GLuint	numImages,
		KTX_image_info	images[]
	)

Write image(s) to a KTX file on disk.

Parameters:

[in]	dstname	pointer to a C string that contains the path of the file to load.
[in]	textureInfo	pointer to a KTX_image_info structure providing information about the images to be included in the KTX file.
[in]	bytesOfKeyValueData	specifies the number of bytes of key-value data.
[in]	keyValueData	a pointer to the keyValue data.
[in]	numImages	number of images in the following array.
[in]	images	array of KTX_image_info providing image size and data.

Returns:

KTX_SUCCESS on success, other KTX_* enum values on error.

Exceptions:

KTX_FILE_OPEN_FAILED

unable to open the specified file for writing.

For other exceptions, see ktxWriteKTXF().