Unofficial OpenGL Software Development Kit: glimg Namespace Reference

Unofficial OpenGL Software Development Kit 0.5.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Namespace List
- Namespace Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Namespaces | Classes | Typedefs | Enumerations | Functions
glimg Namespace Reference

The main GL Image library namespace. More...

## Namespaces

namespace | loaders
| Namespace for all file loaders.

## Classes

class | ImageCreator
| A factory object for creating ImageSet objects. More...
class | ImageCreationException
| Base class for all exceptions thrown by ImageCreator. More...
class | BadFaceCountException
| Thrown if the ImageCreator is given a face count other than 1 or 6. More...
class | CubemapsMustBe2DException
| Thrown if the user attempts to provide a cubemap that isn't two-dimensional. More...
class | No3DTextureArrayException
| Thrown if the user attempts to have 3D array images, which are not allowed. More...
class | NoImagesSpecifiedException
| Thrown if the mipmap or array count is not greater than zero. More...
class | ArrayOutOfBoundsException
| Thrown if the ImageCreator is asked to insert an image outside of the arrayCount. More...
class | MipmapLayerOutOfBoundsException
| Thrown if the ImageCreator is asked to insert an image outside of the mipmapCount. More...
class | FaceIndexOutOfBoundsException
| Thrown if the ImageCreator is asked to insert an image outside of the faceCount. More...
class | ImageSetAlreadyCreatedException
| Thrown when attempting to do anything except destroy an ImageCreator object after calling ImageCreator::CreateImage. More...
struct | UncheckedImageFormat
| Represents a potentially valid image format. More...
class | InvalidFormatException
| Thrown if an invalid format is used by any API. Usually contains an explanation of the problem. More...
class | ImageFormat
| An immutable combination of image format parameters. More...
struct | Dimensions
| Describes the dimensionality of an image. More...
class | SingleImage
| Represents a single image of a certain dimensionality. More...
class | ImageSet
| Represents a set of images that can be stored in a texture object. More...
struct | OpenGLPixelTransferParams
| Contains the pixel transfer parameters for OpenGL texture upload functions. More...
class | TextureGenerationException
| Base class for all exceptions thrown by the texture loaders. More...
class | ImageFormatUnsupportedException
| Thrown if the image format cannot be used because the OpenGL implementation doesn't support the format. More...
class | TextureUnsupportedException
| Thrown if the texture type that was asked to be created is not supported by this OpenGL implementation. More...
class | TextureUnexpectedException
| Thrown because the texture type is not yet supported by GL Image. More...
class | CannotForceRenderTargetException
| Thrown when using the FORCE_REQUIRED_FORMATS flag and the format could not be converted to a required one without compromising data. More...
class | CannotForceTextureStorage
| Thrown when using the FORCE_TEXTURE_STORAGE flag and the OpenGL implementation doesn't support it. More...
class | CannotForceDSAUsage
| Thrown when using the FORCE_DSA flag and the OpenGL implementation doesn't support it. More...

## Typedefs

typedef std::vector< unsigned char > | ImageBuffer
| A useful typedef for automatic memory management of image data.

## Enumerations

enum

PixelDataType {
DT_NORM_UNSIGNED_INTEGER, DT_NORM_SIGNED_INTEGER, DT_UNSIGNED_INTEGRAL, DT_SIGNED_INTEGRAL,
DT_FLOAT, DT_SHARED_EXP_FLOAT , DT_COMPRESSED_BC1 = DT_NUM_UNCOMPRESSED_TYPES, DT_COMPRESSED_BC2,
DT_COMPRESSED_BC3, DT_COMPRESSED_UNSIGNED_BC4, DT_COMPRESSED_SIGNED_BC4, DT_COMPRESSED_UNSIGNED_BC5,
DT_COMPRESSED_SIGNED_BC5, DT_COMPRESSED_UNSIGNED_BC6H, DT_COMPRESSED_SIGNED_BC6H, DT_COMPRESSED_BC7
}

| Describes the basic type of the pixel data. More...
enum | PixelComponents { FMT_COLOR_RED, FMT_COLOR_RG, FMT_COLOR_RGB, FMT_COLOR_RGBX, FMT_COLOR_RGBA, FMT_COLOR_RGB_sRGB, FMT_COLOR_RGBX_sRGB, FMT_COLOR_RGBA_sRGB, FMT_DEPTH, FMT_DEPTH_X }
| Describes the components stored in a pixel of the image. More...
enum | ComponentOrder { ORDER_RGBA, ORDER_BGRA, ORDER_RGBE, ORDER_DEPTH_STENCIL, ORDER_COMPRESSED }
| Specifies the ordering of the component data in the image. More...

enum

Bitdepth {
BD_COMPRESSED, BD_PER_COMP_8, BD_PER_COMP_16, BD_PER_COMP_32 ,
BD_PACKED_16_BIT_565 = BD_NUM_PER_COMPONENT, BD_PACKED_16_BIT_5551, BD_PACKED_16_BIT_4444, BD_PACKED_32_BIT_8888,
BD_PACKED_32_BIT_1010102, BD_PACKED_32_BIT_248, BD_PACKED_16_BIT_565_REV, BD_PACKED_16_BIT_1555_REV,
BD_PACKED_16_BIT_4444_REV, BD_PACKED_32_BIT_8888_REV, BD_PACKED_32_BIT_2101010_REV, BD_PACKED_32_BIT_101111_REV,
BD_PACKED_32_BIT_5999_REV
}

| Specifies the bitdepth for each component of each pixel. More...

enum

ForcedConvertFlags {
FORCE_SRGB_COLORSPACE_FMT = 0x0001, FORCE_BC1_ALPHA_FMT = 0x0002, FORCE_LUMINANCE_FMT = 0x0008, FORCE_INTEGRAL_FMT = 0x0020,
FORCE_SIGNED_FMT = 0x0040, FORCE_COLOR_RENDERABLE_FMT = 0x0080, FORCE_ARRAY_TEXTURE = 0x0004, USE_TEXTURE_STORAGE = 0x0100,
FORCE_TEXTURE_STORAGE = 0x0200, USE_DSA = 0x0400, FORCE_DSA = 0x0800
}

| Control flags for texture conversion processes. More...

## Functions

unsigned int | GetInternalFormat (const ImageFormat &format, unsigned int forceConvertBits)
| Retrieves the OpenGL internal format for the given image format and bits. More...
OpenGLPixelTransferParams | GetUploadFormatType (const ImageFormat &format, unsigned int forceConvertBits)
| Retrieves the pixel transfer parameters for the given image format. More...
unsigned int | GetTextureType (const ImageSet *pImage, unsigned int forceConvertBits)
| Retrieves the texture type for the given ImageSet. More...
unsigned int | CreateTexture (const ImageSet *pImage, unsigned int forceConvertBits)
| Creates a texture object from the given ImageSet, with flags. More...
void | CreateTexture (unsigned int textureName, const ImageSet *pImage, unsigned int forceConvertBits)
| As CreateTexture(const ImageSet *, unsigned int), but with a texture object provided by the user. More...

## Detailed Description

The main GL Image library namespace.