Gizmo3D

gzImage.h File Reference

Image utilites (bitmaps). More...

#include "gzBase.h"
#include "gzReference.h"
#include "gzSerialize.h"
#include "gzRGBA.h"
#include "gzObject.h"

Go to the source code of this file.

Classes

class  gzImage
class  gzImageManager

Defines

#define GZ_EVALUATE_EXTENSION   ("<*!*>")
#define GZ_IMAGE_FLAG_NUM(x)   (gzSerializeAdapterFlags)(1<<( x+GZ_SERIALIZE_ADAPTER_FLAG_MAX_SIZE))

Enumerations

enum  gzImageChanges { GZ_IMAGE_CHANGE_DATA = 1<<0, GZ_IMAGE_CHANGE_FORMAT = 1<<1, GZ_IMAGE_CHANGE_ALL = GZ_IMAGE_CHANGE_DATA+GZ_IMAGE_CHANGE_FORMAT }
enum  gzImageType {
  GZ_IMAGE_TYPE_RGB_8, GZ_IMAGE_TYPE_RGBA_8, GZ_IMAGE_TYPE_BW_8, GZ_IMAGE_TYPE_BWA_8,
  GZ_IMAGE_TYPE_DEPTHMAP, GZ_IMAGE_TYPE_BITMAP, GZ_IMAGE_TYPE_BGRA_5_5_5_1, GZ_IMAGE_TYPE_BGR_5_6_5,
  GZ_IMAGE_TYPE_CUSTOM
}

Functions

 GZ_DECLARE_REFPTR (gzImage)

Variables

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_DEFAULT = (gzSerializeAdapterFlags)0
const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_FLIP_DDS_IMAGES = GZ_IMAGE_FLAG_NUM(0)
const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_NO_CACHED_IMAGE = GZ_IMAGE_FLAG_NUM(1)
const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_NO_ALTERNATE_IMAGE_EXT = GZ_IMAGE_FLAG_NUM(2)
const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_IGNORE_IMAGE_MIPMAPS = GZ_IMAGE_FLAG_NUM(3)
const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_NO_DXT1_ALPHA = GZ_IMAGE_FLAG_NUM(4)
 Use this flag to load dxt1 images (.dds) without alpha.
const gzULongLong GZ_IMAGE_FLAG_MAX_SIZE = GZ_SERIALIZE_ADAPTER_FLAG_MAX_SIZE+5
 Definition of how many flags there are in gzImageFlags.


Detailed Description

Image utilites (bitmaps).

Various formats of image data. All types of image data are derived from the base class gzImage. You can provide your own formats as long as you implement the virtual functions in gzImage.

Definition in file gzImage.h.


Define Documentation

#define GZ_EVALUATE_EXTENSION   ("<*!*>")
 

Examples:
billboard.cpp, dbviewer.cpp, lod.cpp, and mirror.cpp.

Definition at line 322 of file gzImage.h.

#define GZ_IMAGE_FLAG_NUM  )     (gzSerializeAdapterFlags)(1<<( x+GZ_SERIALIZE_ADAPTER_FLAG_MAX_SIZE))
 

These flags defines the behaviour of hhow the loader processes the images at load time

Definition at line 327 of file gzImage.h.


Enumeration Type Documentation

enum gzImageChanges
 

Enumerator:
GZ_IMAGE_CHANGE_DATA 
GZ_IMAGE_CHANGE_FORMAT 
GZ_IMAGE_CHANGE_ALL 

Definition at line 40 of file gzImage.h.

enum gzImageType
 

Enumerator:
GZ_IMAGE_TYPE_RGB_8  An image with RGB format. It has three components: Red, Green and Blue.
GZ_IMAGE_TYPE_RGBA_8  An image with RGBA format. It has four components: Red, Green, Blue and Alpha.
GZ_IMAGE_TYPE_BW_8 
GZ_IMAGE_TYPE_BWA_8 
GZ_IMAGE_TYPE_DEPTHMAP 
GZ_IMAGE_TYPE_BITMAP 
GZ_IMAGE_TYPE_BGRA_5_5_5_1 
GZ_IMAGE_TYPE_BGR_5_6_5 
GZ_IMAGE_TYPE_CUSTOM 

Definition at line 47 of file gzImage.h.


Function Documentation

GZ_DECLARE_REFPTR gzImage   ) 
 


Variable Documentation

const gzULongLong GZ_IMAGE_FLAG_MAX_SIZE = GZ_SERIALIZE_ADAPTER_FLAG_MAX_SIZE+5
 

Definition of how many flags there are in gzImageFlags.

Definition at line 356 of file gzImage.h.

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_DEFAULT = (gzSerializeAdapterFlags)0
 

Definition at line 329 of file gzImage.h.

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_FLIP_DDS_IMAGES = GZ_IMAGE_FLAG_NUM(0)
 

This will flip .dds images referenced by the dataset as the .dds format is ambigious from some vendors.

Definition at line 334 of file gzImage.h.

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_IGNORE_IMAGE_MIPMAPS = GZ_IMAGE_FLAG_NUM(3)
 

Definition at line 350 of file gzImage.h.

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_NO_ALTERNATE_IMAGE_EXT = GZ_IMAGE_FLAG_NUM(2)
 

Gizmo3D normally tries to load alternate images when an image is not understood by the loader. E.g. a database might reference a file “test.tiff” and there is no “tiff” reader registered. In that case Gizmo3D normally want to find a “test.dds” or a “test.bmp” file. This flag disables that search.

Examples:
dbviewer.cpp.

Definition at line 349 of file gzImage.h.

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_NO_CACHED_IMAGE = GZ_IMAGE_FLAG_NUM(1)
 

The image will not be cached for later on usage and you will not use any cahced image so a new read is done. Normally when an image is read by a loader the image is cached so consecutive loaders will use the same instance. Sometimes you want to change path with the GIZMO_PATH environment variable to change time of year etc. Then you want to use the same name of the image but a different file.

Definition at line 342 of file gzImage.h.

const gzSerializeAdapterFlags GZ_IMAGE_FLAGS_NO_DXT1_ALPHA = GZ_IMAGE_FLAG_NUM(4)
 

Use this flag to load dxt1 images (.dds) without alpha.

Definition at line 353 of file gzImage.h.


Documentation for Gizmo3D generated at Wed Feb 20 11:54:13 2008 by   Saab Training Systems AB, ¸ (c) 2003-and beyond