Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
GrayLib::cSurfaceFrames Class Referenceabstract

#include <cSurfaceBase.h>

Inheritance diagram for GrayLib::cSurfaceFrames:
GrayCodec::cImageJP2 GrayCodec::cImagePNG GrayLib::cImageDDS GrayLib::cImageGIF

Public Member Functions

 cSurfaceFrames () noexcept
 
void InitFrameCur () noexcept
 
virtual HRESULT SetFrameCurrent (int iFrameNum)=0
 

Public Attributes

cWinSize m_SizeOrig
 Original MAX reference image size. NOT the current frame size. More...
 
int m_nFrameQty
 max components/frames in the file (DDS,GIF,JP2,PNG) (NOTE doesn't know how many frames until reach end) More...
 
int m_nFrameCur
 the enum of the current locked component/frame. < m_nFrameQty More...
 
size_t m_nFrameOffset
 offset in bytes from the start to m_nFrameCur frame data. More...
 
POINT m_ptFrameOffset
 Current Frame offset in m_SizeOrig. More...
 

Detailed Description

Describe a data blob that has (or can have) multiple image components/frames in it. e.g. DDS,GIF,JP2,PNG all have multi frame ability.
Frames may be LOD (MIP Maps) or animations. May have different sizes.

Note
The attached cSurfaceBase describes the current frame size! (i.e. frame size/offset may change for each frame)

Constructor & Destructor Documentation

◆ cSurfaceFrames()

GrayLib::cSurfaceFrames::cSurfaceFrames ( )
inlinenoexcept

Member Function Documentation

◆ InitFrameCur()

void GrayLib::cSurfaceFrames::InitFrameCur ( )
inlinenoexcept

go back to the first frame.

◆ SetFrameCurrent()

virtual HRESULT GrayLib::cSurfaceFrames::SetFrameCurrent ( int  iFrameNum)
pure virtual

Member Data Documentation

◆ m_nFrameCur

int GrayLib::cSurfaceFrames::m_nFrameCur

the enum of the current locked component/frame. < m_nFrameQty

◆ m_nFrameOffset

size_t GrayLib::cSurfaceFrames::m_nFrameOffset

offset in bytes from the start to m_nFrameCur frame data.

◆ m_nFrameQty

int GrayLib::cSurfaceFrames::m_nFrameQty

max components/frames in the file (DDS,GIF,JP2,PNG) (NOTE doesn't know how many frames until reach end)

◆ m_ptFrameOffset

POINT GrayLib::cSurfaceFrames::m_ptFrameOffset

Current Frame offset in m_SizeOrig.

◆ m_SizeOrig

cWinSize GrayLib::cSurfaceFrames::m_SizeOrig

Original MAX reference image size. NOT the current frame size.


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