SRL::VDP2::ScrollScreen< ScreenType, Id, On > Class Template Reference

Detailed Description

template<class ScreenType, int16_t Id, uint16_t On>
class SRL::VDP2::ScrollScreen< ScreenType, Id, On >

Functionality available to all Scroll Screen interfaces.

#include <srl_vdp2.hpp>

Static Public Member Functions
static void *	GetCellAddress ()
	Gets the starting address in VRAM of Cel data allocated to this scroll.
static uint32_t	GetCellOffset (SRL::Tilemap::TilemapInfo &tile, void *cellAddress)
	Compute the offset that must be added to map data When Corresponding Cel Data does not start on a VRAM bank boundary.
static void *	GetMapAddress ()
	Gets the starting address in VRAM of Map data allocated to this scroll.
static void *	GetPageAddress (uint8_t index)
	returns the VRAM Address of the specified page number in a scroll's Page Table or nullptr if the requested page is outside of allocated Map Bounds
static uint32_t	GetPalOffset (int8_t paletteID=-1)
	Gets the Pallet Bank That must be included in Map Data to Reference a Palette in CRAM.
static void *	GetPlaneAddress (uint8_t index)
	Gets the VRAM Address of the specified plane in a scroll's Page Table (units of 1x1, 2x1, or 2x2 pages)
static void	LoadTilemap (SRL::Tilemap::ITilemap &tilemap)
	Loads Tilemap data to VRAM using ITilemap Interface and configures the Scroll Screen to use it.
static void	ScrollDisable ()
	Removes the Scroll Screen from VDP2 cycle pattern register to disable display.
static void	ScrollEnable ()
	Registers Scroll in VDP2 cycle pattern to enable display of this Scroll Screen.
static void *	SetCellAddress (void *address, int size)
	Manually Sets VRAM area for Cell Data (Advanced Use Cases)
static void *	SetMapAddress (void *Address, int Size)
	Manually Sets VRAM area for Map Data (Advanced Use Cases)
static void	SetMapLayout (uint8_t a, uint8_t b, uint8_t c, uint8_t d)
	Manually set the Plane layout of a Scroll Screen.
static void	SetOpacity (Math::Fxp opacity=1.0)
	Set the opacity of a scroll screen.
static void	SetPriority (SRL::VDP2::Priority pr)
	Set the Display Priority of a Scroll Screen.
static void	TransparentDisable ()
	Disable transparent pixels for a scroll screen.
static void	TransparentEnable ()
	Enable transparent pixels for a scroll screen.
static void	UseColorOffset (VDP2::OffsetChannel mode)
	Sets Which Color Offset that a scroll Screen should use.

Static Public Attributes
static void *	CellAddress = (void*)(VDP2_VRAM_A0 - 1)
	VRAM Address to start of Cell data when displying Tilemap or Bitmap data when using bitmaps.
static int	CellAllocSize = -1
static Tilemap::TilemapInfo	Info = Tilemap::TilemapInfo()
	Tilemap config info for the ScrollScreen.
static void *	MapAddress = (void*)(VDP2_VRAM_A0 - 1)
	VRAM Address of ScrollScreen's Map data when displaying Tilemap.
static int	MapAllocSize = -1
	Size of manually allocated VRAM for Map Data.
static constexpr int16_t	ScreenID = Id
	SGL identifier for the ScrollScreen.
static constexpr uint16_t	ScreenON = On
	SGL flag for the ScrollScreen.
static CRAM::Palette	TilePalette = CRAM::Palette()
	CRAM Pallet for the ScrollScreen.