resonance 1.0.1
Loading...
Searching...
No Matches
ACanvasLin4 Class Reference

Linear addressing for a canvas of four-bit indexed pixels. More...

#include <acanvaslin4.h>

Inheritance diagram for ACanvasLin4:
Collaboration diagram for ACanvasLin4:

Public Member Functions

 ACanvasLin4 (const ABitmap &bitmap)
 Construct over a bitmap.
virtual ~ACanvasLin4 ()
 Slot 1.
virtual void DrawPixelU (int nX, int nY)
 Slot 13.
virtual void DrawPixel8U (int nX, int nY, int nIndex)
 Slot 15.
virtual int GetPixel8U (int nX, int nY)
 Slot 25.
virtual void DrawBitmapLin4U (const ABitmap &source, int nX, int nY)
 Slot 47.
virtual void DrawBitmapLin8U (const ABitmap &source, int nX, int nY)
 Slot 49.
virtual void DrawBitmapRle8U (const ABitmap &source, int nX, int nY)
 Slot 57.
Public Member Functions inherited from ACanvas8
 ACanvas8 (const ABitmap &bitmap)
 Construct over a bitmap.
virtual ~ACanvas8 ()
 Slot 1.
virtual void SetColor8 (int nIndex)
 Slot 2.
virtual void SetColor15 (unsigned short nColor)
 Slot 3.
virtual void SetColor24 (const unsigned char *pRGB)
 Slot 4.
virtual void SetColor32 (unsigned int nColor)
 Slot 5.
virtual void SetColorNative (unsigned int nColor)
 Slot 6.
virtual int GetColor8 ()
 Slot 7.
virtual unsigned short GetColor15 ()
 Slot 8.
virtual void GetColor24 (unsigned char *pRGB)
 Slot 9.
virtual unsigned int GetColor32 ()
 Slot 10.
virtual unsigned int GetColorNative ()
 Slot 11.
virtual void SetAlphaValues (unsigned int nColorKey)
 Slot 12.
virtual void DrawPixel15U (int nX, int nY, unsigned short nColor)
 Slot 17.
virtual void DrawPixel24U (int nX, int nY, const unsigned char *pRGB)
 Slot 19.
virtual void DrawPixel32U (int nX, int nY, unsigned int nColor)
 Slot 21.
virtual void DrawPixelNativeU (int nX, int nY, unsigned int nColor)
 Slot 23.
virtual unsigned short GetPixel15U (int nX, int nY)
 Slot 27.
virtual void GetPixel24U (int nX, int nY, unsigned char *pRGB)
 Slot 29.
virtual unsigned int GetPixel32U (int nX, int nY)
 Slot 31.
virtual unsigned int GetPixelNativeU (int nX, int nY)
 Slot 33.
Public Member Functions inherited from ACanvas
 ACanvas (const ABitmap &bitmap)
 Adopt a pixel description.
void QuantizeToRamps (ACanvas &dest, const std::vector< const Color * > &colors) const
 Reduce this canvas's 32 bit pixels to palette indices over ramps of the given colours.
void DrawBitmap (const ABitmap &source, int nX, int nY)
 Copy a source bitmap, clipped, choosing the slot by source format.
virtual ~ACanvas ()
 Release the canvas.
virtual void DrawPixel (int nX, int nY)
 Store the pen colour at one point.
virtual void DrawPixel8 (int nX, int nY, int nIndex)
 Store one palette index at one point, clipped.
virtual void DrawPixel15 (int nX, int nY, unsigned short nColor)
 Store one 1555 colour at one point, clipped.
virtual void DrawPixel24 (int nX, int nY, const unsigned char *pRGB)
 Store one red, green, blue triple at one point, clipped.
virtual void DrawPixel32 (int nX, int nY, unsigned int nColor)
 Store one 8888 colour at one point, clipped.
virtual void DrawPixelNative (int nX, int nY, unsigned int nColor)
 Store one value in the canvas storage width at one point, clipped.
virtual int GetPixel8 (int nX, int nY)
 Read one point as a palette index, clipped.
virtual unsigned short GetPixel15 (int nX, int nY)
 Read one point as a 1555 colour, clipped.
virtual void GetPixel24 (int nX, int nY, unsigned char *pRGB)
 Read one point into three bytes in red, green, blue order, clipped.
virtual unsigned int GetPixel32 (int nX, int nY)
 Read one point as an 8888 colour, clipped.
virtual unsigned int GetPixelNative (int nX, int nY)
 Read one point in the canvas storage width, clipped.
virtual void DrawHorzLineU (int nY, int nLeft, int nRight)
 Fill part of one row with the pen colour, with no clip test.
virtual void DrawHorzLine (int nY, int nLeft, int nRight)
 Fill part of one row with the pen colour.
virtual void DrawVertLineU (int nX, int nTop, int nBottom)
 Fill part of one column with the pen colour, with no clip test.
virtual void DrawVertLine (int nX, int nTop, int nBottom)
 Fill part of one column with the pen colour, clamped to the clip rectangle.
virtual void DrawRectU (ARect rect)
 Fill a rectangle with the pen colour, with no clip test.
virtual void DrawRect (ARect rect)
 Fill a rectangle with the pen colour.
virtual void DrawBoxU (ARect rect)
 Draw the four edges of a rectangle in the pen colour, with no clip test.
virtual void DrawBox (ARect rect)
 Draw the four edges of a rectangle in the pen colour, through the clipped fills.
virtual void DrawClutRectU (ARect rect, const unsigned char *pRemap)
 Rewrite every palette index inside a rectangle through a remap table.
virtual void DrawLineU (int nX0, int nY0, int nX1, int nY1)
 Draw a line in the pen colour, with no clip test.
virtual void DrawLine (int nX0, int nY0, int nX1, int nY1)
 Draw a line in the pen colour, clipped.
virtual void DrawTmapRow8U (int nY, int nLeft, int nRight, const ABitmap *pSource, APoint *pSourcePosition, const APoint *pSourceStep)
 Fill part of one row by sampling an indexed source bitmap along a fixed step.
virtual void DrawBitmapLin4 (const ABitmap &source, int nX, int nY)
 Copy a four bit source bitmap, clipped.
virtual void DrawBitmapLin8 (const ABitmap &source, int nX, int nY)
 Copy an eight bit source bitmap, clipped.
virtual void DrawBitmapLin15U (const ABitmap &source, int nX, int nY)
 Copy a 1555 source bitmap, with no clip test.
virtual void DrawBitmapLin15 (const ABitmap &source, int nX, int nY)
 Copy a 1555 source bitmap, clipped.
virtual void DrawBitmapLin24U (const ABitmap &source, int nX, int nY)
 Copy a 24 bit source bitmap, with no clip test.
virtual void DrawBitmapLin24 (const ABitmap &source, int nX, int nY)
 Copy a 24 bit source bitmap, clipped.
virtual void DrawBitmapLin32U (const ABitmap &source, int nX, int nY)
 Copy a 32 bit source bitmap, with no clip test.
virtual void DrawBitmapLin32 (const ABitmap &source, int nX, int nY)
 Copy a 32 bit source bitmap, clipped.
virtual void DrawBitmapRle8 (const ABitmap &source, int nX, int nY)
 Copy a run length encoded eight bit source bitmap, clipped.
virtual void GetBitmapLin4 (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a four bit bitmap, clipped.
virtual void GetBitmapLin4U (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a four bit bitmap, with no clip test.
virtual void GetBitmapLin8 (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into an eight bit bitmap, clipped.
virtual void GetBitmapLin8U (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into an eight bit bitmap, with no clip test.
virtual void GetBitmapLin15 (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a 1555 bitmap, clipped.
virtual void GetBitmapLin15U (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a 1555 bitmap, with no clip test.
virtual void GetBitmapLin24 (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a 24 bit bitmap, clipped.
virtual void GetBitmapLin24U (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a 24 bit bitmap, with no clip test.
virtual void GetBitmapLin32 (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a 32 bit bitmap, clipped.
virtual void GetBitmapLin32U (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a 32 bit bitmap, with no clip test.
virtual void DrawCharU (int nCharCode, const AFont *pFont, int nX, int nY)
 Draw one glyph of a font, with no clip test.
virtual void DrawChar (int nCharCode, const AFont *pFont, int nX, int nY)
 Draw one glyph of a font, clipped.
virtual void DrawTextU (const char *pText, const AFont *pFont, int nX, int nY)
 Draw a null terminated string, with no clip test.
virtual void DrawText (const char *pText, const AFont *pFont, int nX, int nY)
 Draw a null terminated string, clipped.
virtual void DrawClutBitmapLin4U (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Copy a four bit source bitmap through a remap table.
virtual void DrawClutBitmapLin8U (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Copy an eight bit source bitmap through a remap table, one row at a time.
virtual void DrawClutBitmapRowLin8U (const ARowInfo &span, const unsigned char *pRemap)
 Store one row of palette indices through a remap table.
virtual void DrawBlendBitmapLin4U (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Copy a four bit source bitmap through a blend table.
virtual void DrawBlendBitmapLin8U (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Copy an eight bit source bitmap through a blend table.
virtual void DrawBlendBitmapRowLin8U (const ARowInfo &span, const unsigned char *const *ppBlend)
 Store one row of palette indices blended against the destination.
virtual void DrawScaledBitmapRowLin8U (const AScaledRowInfo &span)
 Store one row of palette indices sampled along a fixed step.
virtual void DrawScaledBitmapRowLin15U (const AScaledRowInfo &span)
 Store one row of 1555 colours sampled along a fixed step.
virtual void DrawScaledBitmapRowLin24U (const AScaledRowInfo &span)
 Store one row of red, green, blue triples sampled along a fixed step.
virtual void DrawScaledBitmapRowLin32U (const AScaledRowInfo &span)
 Store one row of 8888 colours sampled along a fixed step.
virtual void DrawScaledClutBitmapRowLin8U (const AScaledRowInfo &span, const unsigned char *pRemap)
 Store one row of palette indices sampled along a fixed step, through a remap table.
virtual void DrawScaledBlendBitmapRowLin8U (const AScaledRowInfo &span, const unsigned char *const *ppBlend)
 Store one row of palette indices sampled along a fixed step, blended against the destination.

Additional Inherited Members

Static Public Member Functions inherited from ACanvas
static ACanvas * NewCompatibleCanvas (const ABitmap &bitmap, bool bAllocatePixels)
 Construct the linear canvas subclass that draws a bitmap's format.
static ACanvas * NewCompatibleLinearCanvas (const ABitmap &bitmap)
 Construct a canvas over a fresh pixel rectangle shaped like a bitmap.
static ACanvas * SubCanvas (const ABitmap &source, int nX, int nY, int nWidth, int nHeight)
 Construct a canvas over a rectangle of a bitmap's pixels, sharing them.
Public Attributes inherited from ACanvas
ABitmap mBitmap
ARect mClip
Static Public Attributes inherited from ACanvas
static APalette * palDefault
 Palette every canvas falls back to when neither its bitmap nor its source supplies one.
static unsigned char tempBuff []
 One row of indices, shared by every block copy that has to expand a row before writing it.
Protected Member Functions inherited from ACanvas
unsigned char ClipCode (int nX, int nY) const
 Classify a point against the clip rectangle.
int ClipRle8Bitmap (const ABitmap &source, int *pnX, int *pnY, ARle8Reader *pReader, Rle8Clip *pSpan) const
 Clip a run length encoded copy against the clip rectangle.
int ClipLine (int *pnX0, int *pnY0, int *pnX1, int *pnY1) const
 Clip a line against the clip rectangle, rewriting both endpoints in place.
int ClipBitmap (ABitmap *pBitmap, int *pnX, int *pnY) const
 Clip a source bitmap and a destination position against the clip rectangle.
int ClipRect (ARect *pRect) const
 Intersect a rectangle with the clip rectangle in place.
void DrawClutRect (ARect rect, const unsigned char *pRemap)
 Rewrite the palette indices inside a rectangle through a remap table, clipped.
void DrawBitmapU (const ABitmap &source, int nX, int nY)
 Copy a source bitmap, with no clip test, choosing the slot by source format.
void DrawClutBitmapLin4 (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Clip against the clip rectangle and then copy a four bit source through a remap table.
void DrawClutBitmapLin8 (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Clip against the clip rectangle and then copy an eight bit source through a remap table.
void DrawBlendBitmapLin4 (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Clip against the clip rectangle and then copy a four bit source through a blend table.
void DrawBlendBitmapLin8 (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Clip against the clip rectangle and then copy an eight bit source through a blend table.
void DrawFlatConvexPolygon (const APolygon &polygon)
 Fill a convex polygon with its colour.
void DrawTmappedConvexPolygon (const APolygon &polygon)
 Fill a convex polygon by sampling its texture.
void DrawClutBitmapU (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Copy a source bitmap through a remap table, choosing the arm by source format.
void DrawClutBitmap (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Clip against the clip rectangle and then copy through a remap table.
void DrawClutBitmapRle8U (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Copy a run length encoded source through a remap table.
void DrawClutBitmapRle8 (const ABitmap &source, int nX, int nY, const unsigned char *pRemap)
 Clip and copy a run length encoded source through a remap table.
void DrawBlendBitmapU (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Copy a source bitmap through a table of blend tables, choosing the arm by source format.
void DrawBlendBitmap (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Clip against the clip rectangle and then copy through a table of blend tables.
void DrawBlendBitmapRle8U (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Copy a run length encoded source through a table of blend tables.
void DrawBlendBitmapRle8 (const ABitmap &source, int nX, int nY, const unsigned char *const *ppBlend)
 Clip and copy a run length encoded source through a table of blend tables.
void GetBitmapU (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a bitmap, choosing the slot by destination format.
void GetBitmap (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a bitmap, clipped, choosing the slot by destination format.
void ReadRectRle8 (const ABitmap &dest, int nX, int nY)
 Read a rectangle of the canvas into a run length encoded bitmap.
int ClipAndSetupScaledBitmap (const ABitmap &source, const ARect &rect, AScaledRowInfo *pBlit) const
 Prepare a stretched copy of a source bitmap into a destination rectangle.
void DrawScaledBitmap (const ABitmap &source, const ARect &rect)
 Stretch a source bitmap into a destination rectangle, choosing the arm by source format.
void DrawScaledBitmapLin4 (const ABitmap &source, const ARect &rect)
 Stretch a four bit source bitmap into a destination rectangle.
void DrawScaledBitmapLin8 (const ABitmap &source, const ARect &rect)
 Stretch an eight bit source bitmap into a destination rectangle, through DrawScaledBitmapRowLin8U().
void DrawScaledBitmapLin15 (const ABitmap &source, const ARect &rect)
 Stretch a 1555 source bitmap into a destination rectangle, through DrawScaledBitmapRowLin15U().
void DrawScaledBitmapLin24 (const ABitmap &source, const ARect &rect)
 Stretch a 24 bit source bitmap into a destination rectangle, through DrawScaledBitmapRowLin24U().
void DrawScaledBitmapLin32 (const ABitmap &source, const ARect &rect)
 Stretch a 32 bit source bitmap into a destination rectangle, through DrawScaledBitmapRowLin32U().
void DrawScaledBitmapRle8 (const ABitmap &source, const ARect &rect)
 Stretch a run length encoded source into a destination rectangle.
void DrawScaledClutBitmap (const ABitmap &source, const ARect &rect, const unsigned char *pRemap)
 Stretch an indexed source through a remap table, choosing the arm by source format.
void DrawScaledClutBitmapLin4 (const ABitmap &source, const ARect &rect, const unsigned char *pRemap)
 Stretch a four bit source through a remap table.
void DrawScaledClutBitmapLin8 (const ABitmap &source, const ARect &rect, const unsigned char *pRemap)
 Stretch an eight bit source through a remap table, through DrawScaledClutBitmapRowLin8U().
void DrawScaledClutBitmapRle8 (const ABitmap &source, const ARect &rect, const unsigned char *pRemap)
 Stretch a run length encoded source through a remap table.
void DrawScaledBlendBitmap (const ABitmap &source, const ARect &rect, const unsigned char *const *ppBlend)
 Stretch an indexed source blended against the destination, choosing the arm by source format.
void DrawScaledBlendBitmapLin8 (const ABitmap &source, const ARect &rect, const unsigned char *const *ppBlend)
 Stretch an eight bit source blended against the destination.
void DrawScaledBlendBitmapLin4 (const ABitmap &source, const ARect &rect, const unsigned char *const *ppBlend)
 Stretch a four bit source blended against the destination.
void DrawScaledBlendBitmapRle8 (const ABitmap &source, const ARect &rect, const unsigned char *const *ppBlend)
 Stretch a run length encoded source blended against the destination.
Static Protected Member Functions inherited from ACanvas
static int SetupLine (int nX0, int nY0, int nX1, int nY1, int *pnStepX, int *pnStepY)
 Derive the per pixel step of a line and return the pixel count.
static int FindTopmostPolyVertex (const APolygon &polygon)
 Return the position in APolygon::mIndices of the vertex with the smallest row.
static void Unpack4 (const unsigned char *pSource, unsigned char *pDest, int nCount, int bStartHighNibble)
 Unpack one row of four bit pixels into one byte each.
Protected Attributes inherited from ACanvas8
unsigned char mColor

Detailed Description

Linear addressing for a canvas of four-bit indexed pixels.

Its RTTI descriptor is at 0x008f0920, and its single public base is ACanvas8 at offset zero. It derives from the FORMAT class rather than from ACanvas, the two-level shape the whole family uses. ACanvas8 supplies the colour conversions and does not implement what depends on how pixels are packed, and this class supplies the packing.

Its table at 0x0083f4d8 runs the same 85 entries as its base's and overrides eight. Three are the pure slots ACanvas8 leaves, which makes this class the first concrete one in the chain. The other three are the block copies, which a linear layout can do far better than the generic per-pixel implementations it inherits.

TWO PIXELS SHARE A BYTE, and the nibble is chosen by the bitmap's odd-start flag. The byte offset inside a row is (nX + mOddNibbleStart) / 2 and the nibble is the low one when (nX ^ mOddNibbleStart) is even. That flag is bit 13 of the halfword at ABitmap +0x04, which abitmap.h already documents as mOddNibbleStart, so the field and the addressing corroborate each other.

The sibling ACanvasLin8 overrides eighteen slots where this one overrides eight, because it also specialises the fills and the row operations. Four bits per pixel makes those harder rather than easier, so this class inherits them.

Constructor & Destructor Documentation

◆ ACanvasLin4()

ACanvasLin4::ACanvasLin4 ( const ABitmap & bitmap)
explicit

Construct over a bitmap.

Parameters
bitmapThe bitmap the canvas addresses.
Ghidra address:
NTSC-U/C: 0x006280d0
Ghidra address:
PAL: 0x00668c60

◆ ~ACanvasLin4()

virtual ACanvasLin4::~ACanvasLin4 ( )
virtual

Slot 1.

The body restores ACanvas's table rather than ACanvas8's, because the inlined destructor chain runs to the root and the intermediate store is dead.

Ghidra address:
NTSC-U/C: 0x00628018
Ghidra address:
PAL: 0x00668ba8

Member Function Documentation

◆ DrawPixelU()

virtual void ACanvasLin4::DrawPixelU ( int nX,
int nY )
virtual

Slot 13.

Writes the stored colour into the addressed nibble.

Ghidra address:
NTSC-U/C: 0x00628108
Ghidra address:
PAL: 0x00668c98

Implements ACanvas.

◆ DrawPixel8U()

virtual void ACanvasLin4::DrawPixel8U ( int nX,
int nY,
int nIndex )
virtual

Slot 15.

Ghidra address:
NTSC-U/C: 0x00628180
Ghidra address:
PAL: 0x00668d10

Implements ACanvas.

◆ GetPixel8U()

virtual int ACanvasLin4::GetPixel8U ( int nX,
int nY )
virtual

Slot 25.

Ghidra address:
NTSC-U/C: 0x006281f0
Ghidra address:
PAL: 0x00668d80

Implements ACanvas.

◆ DrawBitmapLin4U()

virtual void ACanvasLin4::DrawBitmapLin4U ( const ABitmap & source,
int nX,
int nY )
virtual

Slot 47.

Parameters
sourceThe source bitmap.
nXThe destination column.
nYThe destination row.
Ghidra address:
NTSC-U/C: 0x00627e88
Ghidra address:
PAL: 0x00668a18

Reimplemented from ACanvas.

◆ DrawBitmapLin8U()

virtual void ACanvasLin4::DrawBitmapLin8U ( const ABitmap & source,
int nX,
int nY )
virtual

Slot 49.

The destination row advances by two per source row. The copy covers every other row of the destination and consumes half the source height, where the run length encoded sibling advances by one.

Parameters
sourceThe source bitmap.
nXThe destination column.
nYThe destination row.
Ghidra address:
NTSC-U/C: 0x00628248
Ghidra address:
PAL: 0x00668dd8

Reimplemented from ACanvas.

◆ DrawBitmapRle8U()

virtual void ACanvasLin4::DrawBitmapRle8U ( const ABitmap & source,
int nX,
int nY )
virtual

Slot 57.

Parameters
sourceThe source bitmap.
nXThe destination column.
nYThe destination row.
Ghidra address:
NTSC-U/C: 0x006282e0
Ghidra address:
PAL: 0x00668e70

Reimplemented from ACanvas.


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