ktx.h

Go to the documentation of this file.

// Copyright eeGeo Ltd (2012-2014), All Rights Reserved

#pragma once

/*
 * This file copyright (c) 2010 The Khronos Group, Inc.
 */

#define KTX_OPENGL_ES2 1
#include <stdio.h>

#include "KHR/khrplatform.h"

#if KTX_OPENGL
    #ifdef _WIN32
    #include <windows.h>
    #define GL_APIENTRY APIENTRY
    #endif

    #include <GL/gl.h>

    #define KTX_GLFUNCPTRS "gl_funcptrs.h"
    /* Use runtime checks for sized internalformat support. */
    #define KTX_SUPPORT_SIZEDINTERNALFORMATS 1

#elif KTX_OPENGL_ES1

    #include <GLES/gl.h>
    #include <GLES/glext.h>

    #define KTX_GLFUNCPTRS "gles1_funcptrs.h"
    #define KTX_SUPPORT_SIZEDINTERNALFORMATS 0

#elif KTX_OPENGL_ES2

    #include <GLES2/gl2.h>
    #include <GLES2/gl2ext.h>

    #define KTX_GLFUNCPTRS "gles2_funcptrs.h"
    #define KTX_SUPPORT_SIZEDINTERNALFORMATS 0

#else
#error Please #define one of KTX_OPENGL, KTX_OPENGL_ES1, KTX_OPENGL_ES2 as 1
#endif


#ifdef __cplusplus
extern "C" {
#endif

#define KTX_ORIENTATION_KEY "KTXorientation"

#define KTX_ORIENTATION2_FMT "S=%c,T=%c"

#define KTX_ORIENTATION3_FMT "S=%c,T=%c,R=%c"

typedef enum KTX_error_code_t {
    KTX_SUCCESS = 0,         
    KTX_FILE_OPEN_FAILED,    
    KTX_FILE_WRITE_ERROR,    
    KTX_GL_ERROR,            
    KTX_INVALID_OPERATION,   
    KTX_INVALID_VALUE,       
    KTX_NOT_FOUND,           
    KTX_OUT_OF_MEMORY,       
    KTX_UNEXPECTED_END_OF_FILE, 
    KTX_UNKNOWN_FILE_FORMAT, 
    KTX_UNSUPPORTED_TEXTURE_TYPE, 
} KTX_error_code;

typedef struct KTX_texture_info_t
{
    khronos_uint32_t glType;
    khronos_uint32_t glTypeSize;
    khronos_uint32_t glFormat;
    khronos_uint32_t glInternalFormat;
    khronos_uint32_t glBaseInternalFormat;
    khronos_uint32_t pixelWidth;
    khronos_uint32_t pixelHeight;
    khronos_uint32_t pixelDepth;
    khronos_uint32_t numberOfArrayElements;
    khronos_uint32_t numberOfFaces;
    khronos_uint32_t numberOfMipmapLevels;
} KTX_texture_info;


typedef struct KTX_image_info {
    GLsizei size;   
    GLubyte* data;  
} KTX_image_info;


typedef struct KTX_dimensions {
    GLsizei width;  
    GLsizei height; 
    GLsizei depth;  
} KTX_dimensions;

typedef void* KTX_hash_table;

/* ktxLoadTextureF
 *
 * Loads a texture from a stdio FILE.
 */
KTX_error_code
ktxLoadTextureF(FILE*, GLuint* pTexture, GLenum* pTarget,
                KTX_dimensions* pDimensions, GLboolean* pIsMipmapped,
                GLenum* pGlerror,
                unsigned int* pKvdLen, unsigned char** ppKvd);

/* ktxLoadTextureN
 *
 * Loads a texture from a KTX file on disk.
 */
KTX_error_code
ktxLoadTextureN(const char* const filename, GLuint* pTexture, GLenum* pTarget,
                KTX_dimensions* pDimensions, GLboolean* pIsMipmapped,
                GLenum* pGlerror,
                unsigned int* pKvdLen, unsigned char** ppKvd);

/* ktxLoadTextureM
 *
 * Loads a texture from a KTX file in memory.
 */
KTX_error_code
ktxLoadTextureM(const void* bytes, GLsizei size, GLuint* pTexture, GLenum* pTarget,
                KTX_dimensions* pDimensions, GLboolean* pIsMipmapped,
                GLenum* pGlerror,
                unsigned int* pKvdLen, unsigned char** ppKvd);

/* ktxWriteKTXF
 * 
 * Writes a KTX file using supplied data.
 */
KTX_error_code
ktxWriteKTXF(FILE*, const KTX_texture_info* imageInfo,
             GLsizei bytesOfKeyValueData, const void* keyValueData,
             GLuint numImages, KTX_image_info images[]);

/* ktxWriteKTXN
 * 
 * Writes a KTX file using supplied data.
 */
KTX_error_code
ktxWriteKTXN(const char* dstname, const KTX_texture_info* imageInfo,
             GLsizei bytesOfKeyValueData, const void* keyValueData,
             GLuint numImages, KTX_image_info images[]);

/* ktxHashTable_Create()
 *
 * Creates a key-value hash table
 */
KTX_hash_table ktxHashTable_Create();

/* ktxHashTable_Destroy()
 *
 * Destroys a key-value hash table
 */
void ktxHashTable_Destroy(KTX_hash_table This);

/* ktxHashTable_AddKVPair()
 *
 * Adds a key-value pair to a hash table.
 */
KTX_error_code
ktxHashTable_AddKVPair(KTX_hash_table This, const char* key,
                       unsigned int valueLen, const void* value);


/* ktxHashTable_FindValue()
 *
 * Looks up a key and returns the value.
 */
KTX_error_code
ktxHashTable_FindValue(KTX_hash_table This, const char* key,
                       unsigned int* pValueLen, void** pValue);


/* ktxHashTable_Serialize()
 *
 * Serializes the hash table to a block of memory suitable for
 * writing to a KTX file.
 */
KTX_error_code
ktxHashTable_Serialize(KTX_hash_table This, unsigned int* kvdLen, unsigned char** kvd);


/* ktxHashTable_Deserialize()
 *
 * Creates a hash table from the serialized data read from a
 * a KTX file.
 */
KTX_error_code
ktxHashTable_Deserialize(unsigned int kvdLen, void* kvd, KTX_hash_table* pKvt);


#ifdef __cplusplus
}
#endif