Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
ImageInfo Class Reference

#include <ImageInfo.h>

Public Types

enum  {
  UNPACKED = 0x00000001 , PACKED = 0x00000002 , TOOBIG = 0x00000004 , ROTATED90C = 0x00000008 ,
  CANTPROCESS = 0x00000010 , INVALIDCOLORDEPTH = 0x00000020
}
 
enum  {
  FIT_XGUTTER = 0x00000001 , FIT_YGUTTER = 0x00000002 , FIT_XBORDER_RIGHT = 0x00000004 , FIT_XBORDER_LEFT = 0x00000008 ,
  FIT_YBORDER_TOP = 0x00000010 , FIT_YBORDER_BOTTOM = 0x00000020
}
 

Public Member Functions

 ImageInfo ()
 
 ~ImageInfo ()
 

Public Attributes

char * m_path
 path to file
 
char * m_filenameOnly
 filename with extension only (no path information)
 
char * m_filenameOnlyNoExt
 filename without extension and no path info
 
Int m_colorDepth
 bits per pixel
 
UnsignedInt m_area
 width and height area
 
ICoord2D m_size
 width and height of image
 
UnsignedInt m_status
 status bits for image
 
TexturePagem_page
 pointer to page this image is now packed on
 
ImageInfom_nextPageImage
 next image on texture page
 
ImageInfom_prevPageImage
 previous image on texture page
 
IRegion2D m_pagePos
 
UnsignedInt m_fitBits
 
ICoord2D m_gutterUsed
 the gutter size actually used in this image fit
 

Detailed Description

Image file information

Definition at line 60 of file ImageInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
FIT_XGUTTER 

x gutter is present in fit region

FIT_YGUTTER 

y gutter is present in fit region

FIT_XBORDER_RIGHT 

x border of 1 pixel on right side of region

FIT_XBORDER_LEFT 

x border of 1 pixel on left side of region

FIT_YBORDER_TOP 

y border of 1 pixel on top of region

FIT_YBORDER_BOTTOM 

y border of 1 pixel on bottom of image

Definition at line 75 of file ImageInfo.h.

◆ anonymous enum

anonymous enum
Enumerator
UNPACKED 

this image has not yet been packed

PACKED 

this image has been packed and is done

TOOBIG 

this image was too big to process

ROTATED90C 

image is fitted after 90 clockwise rotation

CANTPROCESS 

can't be processed

INVALIDCOLORDEPTH 

unsupported source image format

Definition at line 65 of file ImageInfo.h.

Constructor & Destructor Documentation

◆ ImageInfo()

ImageInfo::ImageInfo ( void )

Definition at line 66 of file ImageInfo.cpp.

◆ ~ImageInfo()

ImageInfo::~ImageInfo ( void )

Definition at line 94 of file ImageInfo.cpp.

Member Data Documentation

◆ m_area

UnsignedInt ImageInfo::m_area

width and height area

Definition at line 94 of file ImageInfo.h.

◆ m_colorDepth

Int ImageInfo::m_colorDepth

bits per pixel

Definition at line 93 of file ImageInfo.h.

◆ m_filenameOnly

char* ImageInfo::m_filenameOnly

filename with extension only (no path information)

Definition at line 91 of file ImageInfo.h.

◆ m_filenameOnlyNoExt

char* ImageInfo::m_filenameOnlyNoExt

filename without extension and no path info

Definition at line 92 of file ImageInfo.h.

◆ m_fitBits

UnsignedInt ImageInfo::m_fitBits

once placed on a texture page this has the coords of the image on the page, it does not include any padding from stretching borders and gutters bit flags of the region used to fit this image on a page and therefore to create m_pagePos

Definition at line 105 of file ImageInfo.h.

◆ m_gutterUsed

ICoord2D ImageInfo::m_gutterUsed

the gutter size actually used in this image fit

Definition at line 107 of file ImageInfo.h.

◆ m_nextPageImage

ImageInfo* ImageInfo::m_nextPageImage

next image on texture page

Definition at line 99 of file ImageInfo.h.

◆ m_page

TexturePage* ImageInfo::m_page

pointer to page this image is now packed on

Definition at line 98 of file ImageInfo.h.

◆ m_pagePos

IRegion2D ImageInfo::m_pagePos

Definition at line 101 of file ImageInfo.h.

◆ m_path

char* ImageInfo::m_path

path to file

Definition at line 90 of file ImageInfo.h.

◆ m_prevPageImage

ImageInfo* ImageInfo::m_prevPageImage

previous image on texture page

Definition at line 100 of file ImageInfo.h.

◆ m_size

ICoord2D ImageInfo::m_size

width and height of image

Definition at line 95 of file ImageInfo.h.

◆ m_status

UnsignedInt ImageInfo::m_status

status bits for image

Definition at line 96 of file ImageInfo.h.


The documentation for this class was generated from the following files: