openmsx::SpriteConverter< Pixel > Class Template Reference

Utility class for converting VRAM contents to host pixels. More...

#include <SpriteConverter.hh>

Public Member Functions
	SpriteConverter (SpriteChecker &spriteChecker_, std::span< const Pixel, 16 > pal)
	Constructor. More...
void	setTransparency (bool enabled)
	Update the transparency setting. More...
void	setDisplayMode (DisplayMode newMode)
	Notify SpriteConverter of a display mode change. More...
void	setPalette (std::span< const Pixel, 16 > newPalette)
	Set palette to use for converting sprites. More...
void	drawMode1 (int absLine, int minX, int maxX, std::span< Pixel > pixelPtr)
	Draw sprites in sprite mode 1. More...
template<unsigned MODE>
void	drawMode2 (int absLine, int minX, int maxX, std::span< Pixel > pixelPtr)
	Draw sprites in sprite mode 2. More...

Static Public Member Functions
static bool	clipPattern (int &x, SpriteChecker::SpritePattern &pattern, int minX, int maxX)

Detailed Description

template<std::unsigned_integral Pixel>
class openmsx::SpriteConverter< Pixel >

Utility class for converting VRAM contents to host pixels.

Definition at line 22 of file SpriteConverter.hh.

Constructor & Destructor Documentation

SpriteConverter()

template<std::unsigned_integral Pixel>

openmsx::SpriteConverter< Pixel >::SpriteConverter ( SpriteChecker &  spriteChecker_, std::span< const Pixel, 16 >  pal  )

inlineexplicit

Constructor.

After construction, also call the various set methods to complete initialisation.

Parameters

spriteChecker_	Delivers the sprite data to be rendered.
pal	The initial palette. Can later be changed via setPallette().

Definition at line 33 of file SpriteConverter.hh.

Member Function Documentation

clipPattern()

template<std::unsigned_integral Pixel>

static bool openmsx::SpriteConverter< Pixel >::clipPattern ( int &  x, SpriteChecker::SpritePattern &  pattern, int  minX, int  maxX  )

inlinestatic

Definition at line 66 of file SpriteConverter.hh.

Referenced by openmsx::SpriteConverter< Pixel >::drawMode1(), and openmsx::SpriteConverter< Pixel >::drawMode2().

drawMode1()

template<std::unsigned_integral Pixel>

void openmsx::SpriteConverter< Pixel >::drawMode1 ( int  absLine, int  minX, int  maxX, std::span< Pixel >  pixelPtr  )

inline

Draw sprites in sprite mode 1.

Parameters

absLine	Absolute line number. Range is [0..262) for NTSC and [0..313) for PAL.
minX	Minimum X coordinate to draw (inclusive).
maxX	Maximum X coordinate to draw (exclusive).
pixelPtr	Pointer to memory to draw to.

Definition at line 98 of file SpriteConverter.hh.

References openmsx::SpriteConverter< Pixel >::clipPattern(), openmsx::SpriteChecker::getSprites(), and view::reverse().

drawMode2()

template<std::unsigned_integral Pixel>

template<unsigned MODE>

void openmsx::SpriteConverter< Pixel >::drawMode2 ( int  absLine, int  minX, int  maxX, std::span< Pixel >  pixelPtr  )

inline

Draw sprites in sprite mode 2.

Make sure the pixel pointers point to a large enough memory area: 256 pixels for ZOOM_256 and ZOOM_REAL in 256-pixel wide modes; 512 pixels for ZOOM_REAL in 512-pixel wide modes.

Parameters

absLine	Absolute line number. Range is [0..262) for NTSC and [0..313) for PAL.
minX	Minimum X coordinate to draw (inclusive).
maxX	Maximum X coordinate to draw (exclusive).
pixelPtr	Pointer to memory to draw to.

Definition at line 144 of file SpriteConverter.hh.

References openmsx::SpriteConverter< Pixel >::clipPattern(), openmsx::SpriteChecker::SpriteInfo::colorAttrib, openmsx::SpriteChecker::getSprites(), openmsx::DisplayMode::GRAPHIC5, openmsx::DisplayMode::GRAPHIC6, openmsx::SpriteChecker::SpriteInfo::pattern, and openmsx::SpriteChecker::SpriteInfo::x.

setDisplayMode()

template<std::unsigned_integral Pixel>

void openmsx::SpriteConverter< Pixel >::setDisplayMode ( DisplayMode  newMode )

inline

Notify SpriteConverter of a display mode change.

Parameters

newMode

The new display mode.

Definition at line 51 of file SpriteConverter.hh.

setPalette()

template<std::unsigned_integral Pixel>

void openmsx::SpriteConverter< Pixel >::setPalette ( std::span< const Pixel, 16 >  newPalette )

inline

Set palette to use for converting sprites.

This palette is stored by reference, so any modifications to it will be used while drawing.

Parameters

newPalette

16-entry array containing the sprite palette.

Definition at line 61 of file SpriteConverter.hh.

setTransparency()

template<std::unsigned_integral Pixel>

void openmsx::SpriteConverter< Pixel >::setTransparency ( bool  enabled )

inline

Update the transparency setting.

Parameters

enabled

The new value.

Definition at line 43 of file SpriteConverter.hh.

---

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

• SpriteConverter.hh