CVidBitmap Class

• Overview

• Quick Reference

• Constructors

• Methods

---

Overview

Note

The CVidBitmap class handles

The structure used for this class is CVidBitmap

---

Quick Reference

Quick Ref

void CVidBitmap::CVidBitmap()

void CVidBitmap::CVidBitmap(CResRef cNewResRef)

void CVidBitmap::CVidBitmap(CResRef cNewResRef, unsigned short nBitCount)

void CVidBitmap::~CVidBitmap()

int CVidBitmap::BindTexture(short nBitCount, unsigned long* pSurface, long lPitch, unsigned char* pData, CSize& bmpSize, long nDataJump)

int CVidBitmap::BltBmp8To32(unsigned long* pSurface, long lPitch, unsigned char* pData, CSize& bmpSize, long nDataJump, unsigned long dwFlags)

int CVidBitmap::BltBmp24To32(unsigned long* pSurface, long lPitch, unsigned char* pData, CSize& bmpSize, long nDataJump, unsigned long dwFlags)

int CVidBitmap::BltBmp32To32(unsigned long* pSurface, long lPitch, unsigned char* pData, int width, int height, unsigned long dwFlags)

short CVidBitmap::GetBitCount()

int CVidBitmap::GetImageDimensions(CSize& size)

int CVidBitmap::GetPixelColor(tagRGBQUAD& color, int x, int y)

unsigned char CVidBitmap::GetPixelValue(int x, int y)

int CVidBitmap::GetPixelValue(unsigned char& value, int x, int y)

void CVidBitmap::Render(int x, int y, CRect& rClipping, unsigned long dwFlags)

void CVidBitmap::RenderScaled(CRect& rArea, CRect& rClip, unsigned long dwFlags)

void CVidBitmap::RenderTexture(int x, int y, CSize& bmpSize, CRect& rClip, unsigned long dwFlags)

void CVidBitmap::SetRes(CResBitmap* pResBmp)

void CVidBitmap::TexImage(unsigned long dwFlags)

---

Constructors

Name	Description
CVidBitmap::CVidBitmap	Constructs a CVidBitmap object
CVidBitmap::CVidBitmap	Destroys a CVidBitmap object

CVidBitmap::CVidBitmap

Constructs a CVidBitmap object

void CVidBitmap::CVidBitmap();

Remarks

Constructs a CVidBitmap object

---

CVidBitmap::CVidBitmap

Constructs a CVidBitmap object

void CVidBitmap::CVidBitmap(CResRef cNewResRef);

Parameters

• CResRef cNewResRef -

Remarks

Constructs a CVidBitmap object

---

CVidBitmap::CVidBitmap

Constructs a CVidBitmap object

void CVidBitmap::CVidBitmap(
   CResRef cNewResRef,
   unsigned short nBitCount);

Parameters

• CResRef cNewResRef -

• unsigned short nBitCount -

Remarks

Constructs a CVidBitmap object

---

CVidBitmap::~CVidBitmap

Destroys the CVidBitmap object

void CVidBitmap::~CVidBitmap();

Remarks

Destroys the CVidBitmap object

---

Methods

Name	Description
CVidBitmap::BindTexture
CVidBitmap::BltBmp8To32
CVidBitmap::BltBmp24To32
CVidBitmap::BltBmp32To32
CVidBitmap::GetBitCount
CVidBitmap::GetImageDimensions
CVidBitmap::GetPixelColor
CVidBitmap::GetPixelValue
CVidBitmap::Render
CVidBitmap::RenderScaled
CVidBitmap::RenderTexture
CVidBitmap::SetRes
CVidBitmap::TexImage

---

CVidBitmap::BindTexture

int CVidBitmap::BindTexture(
   short nBitCount,
   unsigned long* pSurface,
   long lPitch,
   unsigned char* pData,
   CSize& bmpSize,
   long nDataJump);

Parameters

• short nBitCount -

• unsigned long* pSurface -

• long lPitch -

• unsigned char* pData -

• CSize& bmpSize -

• long nDataJump -

Return Value

Returns int

Remarks

---

CVidBitmap::BltBmp8To32

int CVidBitmap::BltBmp8To32(
   unsigned long* pSurface,
   long lPitch,
   unsigned char* pData,
   CSize& bmpSize,
   long nDataJump,
   unsigned long dwFlags);

Parameters

• unsigned long* pSurface -

• long lPitch -

• unsigned char* pData -

• CSize& bmpSize -

• long nDataJump -

• unsigned long dwFlags -

Return Value

Returns int

Remarks

---

CVidBitmap::BltBmp24To32

int CVidBitmap::BltBmp24To32(
   unsigned long* pSurface,
   long lPitch,
   unsigned char* pData,
   CSize& bmpSize,
   long nDataJump,
   unsigned long dwFlags);

Parameters

• unsigned long* pSurface -

• long lPitch -

• unsigned char* pData -

• CSize& bmpSize -

• long nDataJump -

• unsigned long dwFlags -

Return Value

Returns int

Remarks

---

CVidBitmap::BltBmp32To32

int CVidBitmap::BltBmp32To32(
   unsigned long* pSurface,
   long lPitch,
   unsigned char* pData,
   int width,
   int height,
   unsigned long dwFlags);

Parameters

• unsigned long* pSurface -

• long lPitch -

• unsigned char* pData -

• int width -

• int height -

• unsigned long dwFlags -

Return Value

Returns int

Remarks

---

CVidBitmap::GetBitCount

short CVidBitmap::GetBitCount();

Return Value

Returns short

Remarks

---

CVidBitmap::GetImageDimensions

int CVidBitmap::GetImageDimensions(CSize& size);

Parameters

• CSize& size -

Return Value

Returns int

Remarks

---

CVidBitmap::GetPixelColor

int CVidBitmap::GetPixelColor(
   RGBQUAD& color,
   int x,
   int y);

Parameters

• RGBQUAD& color -

• int x -

• int y -

Return Value

Returns int

Remarks

---

CVidBitmap::GetPixelValue

unsigned char CVidBitmap::GetPixelValue(
   int x,
   int y);

Parameters

• int x -

• int y -

Return Value

Returns unsigned char

Remarks

---

CVidBitmap::GetPixelValue

int CVidBitmap::GetPixelValue(
   unsigned char& value
   int x,
   int y);

Parameters

• unsigned char& value -

• int x -

• int y -

Return Value

Returns int

Remarks

---

CVidBitmap::Render

void CVidBitmap::Render(
   int x,
   int y,
   CRect& rClipping,
   unsigned long dwFlags);

Parameters

• int x -

• int y -

• CRect& rClipping -

• unsigned long dwFlags -

Remarks

---

CVidBitmap::RenderScaled

void CVidBitmap::RenderScaled(
   CRect& rArea,
   CRect& rClip,
   unsigned long dwFlags);

Parameters

• CRect& rArea -

• CRect& rClip -

• unsigned long dwFlags -

Remarks

---

CVidBitmap::RenderTexture

void CVidBitmap::RenderTexture(
   int x,
   int y,
   CSize& bmpSize,
   CRect& rClip,
   unsigned long dwFlags);

Parameters

• int x -

• int y -

• CSize& bmpSize -

• CRect& rClip -

• unsigned long dwFlags -

Return Value

Returns

Remarks

---

CVidBitmap::SetRes

void CVidBitmap::SetRes(CResBitmap* pResBmp);

Parameters

• CResBitmap* pResBmp -

Remarks

---

CVidBitmap::TexImage

void CVidBitmap::TexImage(unsigned long dwFlags);

Parameters

• unsigned long dwFlags -

Remarks