Interface IBitmapImage

Namespace

RetroEditor.Plugins

Assembly

RetroEditor.dll

Interface for a bitmap image - used with the BitmapWidget class

public interface IBitmapImage

Properties

Height

Height of the image in pixels

uint Height { get; }

Property Value

uint

Palette

Palette for the image

IBitmapPalette Palette { get; }

Property Value

IBitmapPalette

PixelHeight

Height of a pixel in pixels

uint PixelHeight { get; }

Property Value

uint

PixelWidth

Width of a pixel in pixels

uint PixelWidth { get; }

Property Value

uint

Width

Width of the image in pixels

uint Width { get; }

Property Value

uint

Methods

GetImageData(float)

Image data as a flat array of palette indices

ReadOnlySpan<uint> GetImageData(float seconds)

Parameters

seconds float

Number of seconds since startup

Returns

ReadOnlySpan<uint>

pixel index array

SetPixel(uint, uint, uint)

Set a pixel in the image Is called when a pixel is set in the editor, this should be used to make the change in the games memory

void SetPixel(uint x, uint y, uint paletteIndex)

Parameters

x uint

y uint

paletteIndex uint