Represents a bitmap image optimized for SNES ROM hacking. More...

#include <bitmap.h>

Collaboration diagram for yaze::gfx::Bitmap:

[legend]

Classes
struct	BitmapMetadata
	Metadata for tracking bitmap source format and palette requirements. More...

struct	DirtyRegion

Public Types
enum class	BitmapPurpose : uint8_t { kPreview , kEditable , kSelectionSource , kCompositeOutput }
	How a bitmap is used in the editor pipeline. More...

Public Member Functions
	Bitmap ()=default

	Bitmap (int width, int height, int depth, const std::vector< uint8_t > &data)
	Create a bitmap with the given dimensions and raw pixel data.

	Bitmap (int width, int height, int depth, const std::vector< uint8_t > &data, const SnesPalette &palette)
	Create a bitmap with the given dimensions, data, and SNES palette.

	Bitmap (const Bitmap &other)
	Copy constructor - creates a deep copy.

Bitmap &	operator= (const Bitmap &other)
	Copy assignment operator.

	Bitmap (Bitmap &&other) noexcept
	Move constructor.

Bitmap &	operator= (Bitmap &&other) noexcept
	Move assignment operator.

	~Bitmap ()=default
	Destructor.

void	Create (int width, int height, int depth, std::span< uint8_t > data)
	Create a bitmap with the given dimensions and data.

void	Create (int width, int height, int depth, const std::vector< uint8_t > &data)
	Create a bitmap with the given dimensions and data.

void	Create (int width, int height, int depth, int format, const std::vector< uint8_t > &data)
	Create a bitmap with the given dimensions, format, and data.

void	Reformat (int format)
	Reformat the bitmap to use a different pixel format.

void	Fill (uint8_t value)
	Fill the bitmap with a specific value.

void	CreateTexture ()
	Creates the underlying SDL_Texture to be displayed.

void	UpdateTexture ()
	Updates the underlying SDL_Texture when it already exists.

void	QueueTextureUpdate (IRenderer *renderer)
	Queue texture update for batch processing (improved performance)

void	UpdateTextureData ()
	Updates the texture data from the surface.

void	SetPalette (const SnesPalette &palette)
	Set the palette for the bitmap using SNES palette format.

void	SetPaletteWithTransparent (const SnesPalette &palette, size_t index, int length=7)
	Set the palette with a transparent color.

void	ApplyPaletteByMetadata (const SnesPalette &palette, int sub_palette_index=0)
	Apply palette using metadata-driven strategy Chooses between SetPalette and SetPaletteWithTransparent based on metadata.

void	ApplyStoredPalette ()
	Apply the stored palette to the surface (internal helper)

void	UpdateSurfacePixels ()
	Update SDL surface with current pixel data from data_ vector Call this after modifying pixel data via mutable_data()

void	SetPalette (const std::vector< SDL_Color > &palette)
	Set the palette using SDL colors (direct surface palette access)

void	WriteToPixel (int position, uint8_t value)
	Write a value to a pixel at the given position.

void	WriteToPixel (int x, int y, uint8_t value)
	Write a palette index to a pixel at the given x,y coordinates.

uint8_t	GetPixel (int x, int y) const
	Get the palette index at the given x,y coordinates.

void	WriteColor (int position, const ImVec4 &color)
	Write a color to a pixel at the given position.

void	SetPixel (int x, int y, const SnesColor &color)
	Set a pixel at the given x,y coordinates with SNES color.

void	Resize (int new_width, int new_height)
	Resize the bitmap to new dimensions (preserves existing data)

void	InvalidatePaletteCache ()
	Invalidate the palette lookup cache (call when palette changes)

uint8_t	FindColorIndex (const SnesColor &color)
	Find color index in palette using optimized hash map lookup.

bool	ValidateDataSurfaceSync ()
	Validate that bitmap data and surface pixels are synchronized.

void	Get8x8Tile (int tile_index, int x, int y, std::vector< uint8_t > &tile_data, int &tile_data_offset)
	Extract an 8x8 tile from the bitmap (SNES standard tile size)

void	Get16x16Tile (int tile_x, int tile_y, std::vector< uint8_t > &tile_data, int &tile_data_offset)
	Extract a 16x16 tile from the bitmap (SNES metatile size)

const SnesPalette &	palette () const

SnesPalette *	mutable_palette ()

BitmapMetadata &	metadata ()

const BitmapMetadata &	metadata () const

int	width () const

int	height () const

int	depth () const

bool	IsIndexed () const

SDL_Color	ReadColor (int x, int y) const

std::vector< uint8_t >	ToRgba () const

auto	size () const

const uint8_t *	data () const

std::vector< uint8_t > &	mutable_data ()

SDL_Surface *	surface () const

TextureHandle	texture () const

const std::vector< uint8_t > &	vector () const

uint8_t	at (int i) const

bool	modified () const

bool	is_active () const

uint32_t	generation () const

void	set_active (bool active)

void	set_data (const std::vector< uint8_t > &data)

void	set_modified (bool modified)

void	set_texture (TextureHandle texture)

Private Member Functions
void	CopySurfaceState (const Bitmap &other)

SDL_Surface *	DetachSurfaceForArena () noexcept

TextureHandle	DetachTextureForArena () noexcept

void	MarkRetiredByArena () noexcept

Static Private Member Functions
static uint32_t	HashColor (const ImVec4 &color)
	Hash a color for cache lookup.

Private Attributes
int	width_ = 0

int	height_ = 0

int	depth_ = 0

bool	active_ = false

bool	modified_ = false

uint32_t	generation_ = 0

void *	texture_pixels = nullptr

uint8_t *	pixel_data_ = nullptr

gfx::SnesPalette	palette_
	Internal SNES palette storage (may be empty!)

BitmapMetadata	metadata_

std::vector< uint8_t >	data_

SDL_Surface *	surface_ = nullptr
	SDL surface for rendering (contains the authoritative palette)

TextureHandle	texture_ = nullptr

std::unordered_map< uint32_t, uint8_t >	color_to_index_cache_

struct yaze::gfx::Bitmap::DirtyRegion	dirty_region_

Static Private Attributes
static uint32_t	next_generation_ = 1

Friends
class	Arena

Detailed Description

Represents a bitmap image optimized for SNES ROM hacking.

The Bitmap class provides functionality to create, manipulate, and display bitmap images specifically designed for Link to the Past ROM editing. It supports:

Key Features:

SNES-specific pixel formats (4BPP, 8BPP, indexed)
Palette management with transparent color support
Tile extraction (8x8, 16x16) for ROM tile editing
Memory-efficient surface/texture management via Arena
Real-time editing with immediate visual feedback

Performance Optimizations:

Lazy texture creation (textures only created when needed)
Modified flag tracking to avoid unnecessary updates
Arena-based resource pooling to reduce allocation overhead
Direct pixel data manipulation for fast editing operations

ROM Hacking Specific:

SNES color format conversion (15-bit RGB to 8-bit indexed)
Tile-based editing for 8x8 and 16x16 SNES tiles
Palette index management for ROM palette editing
Support for multiple graphics sheets (223 total in YAZE)

Definition at line 70 of file bitmap.h.

Member Enumeration Documentation

◆ BitmapPurpose

enum class yaze::gfx::Bitmap::BitmapPurpose : uint8_t

strong

How a bitmap is used in the editor pipeline.

Roles describe purpose, not behavior. Bitmap itself stays neutral and doesn't gate operations on this. Editors and Canvas widgets read the field to make informed defaults (e.g. a kPreview bitmap should not be the target of pixel writes; a kCompositeOutput bitmap is downstream of a layer-merge step and gets re-rendered, not edited in place).

Default is kEditable so existing callsites keep their semantics.

Enumerator
kPreview
kEditable
kSelectionSource
kCompositeOutput

Definition at line 364 of file bitmap.h.

Constructor & Destructor Documentation

◆ Bitmap() [1/5]

yaze::gfx::Bitmap::Bitmap ( )

default

◆ Bitmap() [2/5]

yaze::gfx::Bitmap::Bitmap	(	int	width,
		int	height,
		int	depth,
		const std::vector< uint8_t > &	data )

Create a bitmap with the given dimensions and raw pixel data.

Parameters

width	Width in pixels (typically 128, 256, or 512 for SNES tilesheets)
height	Height in pixels (typically 32, 64, or 128 for SNES tilesheets)
depth	Color depth in bits per pixel (4, 8, or 16 for SNES)
data	Raw pixel data (indexed color values for SNES graphics)

Definition at line 48 of file bitmap.cc.

References Create(), data(), depth(), height(), and width().

◆ Bitmap() [3/5]

yaze::gfx::Bitmap::Bitmap	(	int	width,
		int	height,
		int	depth,
		const std::vector< uint8_t > &	data,
		const SnesPalette &	palette )

Create a bitmap with the given dimensions, data, and SNES palette.

Parameters

width	Width in pixels
height	Height in pixels
depth	Color depth in bits per pixel
data	Raw pixel data (indexed color values)
palette	SNES palette for color mapping (15-bit RGB format)

Definition at line 54 of file bitmap.cc.

References Create(), data(), depth(), height(), palette(), SetPalette(), and width().

◆ Bitmap() [4/5]

yaze::gfx::Bitmap::Bitmap ( const Bitmap & other )

Copy constructor - creates a deep copy.

Definition at line 65 of file bitmap.cc.

References active_, yaze::gfx::Arena::AllocateSurface(), CopySurfaceState(), data_, depth_, yaze::gfx::Arena::Get(), yaze::gfx::GetSnesPixelFormat(), height_, yaze::gfx::kIndexed, yaze::gfx::kRgba, pixel_data_, surface_, UpdateSurfacePixels(), and width_.

◆ Bitmap() [5/5]

yaze::gfx::Bitmap::Bitmap ( Bitmap && other )

noexcept

Move constructor.

Definition at line 130 of file bitmap.cc.

◆ ~Bitmap()

yaze::gfx::Bitmap::~Bitmap ( )

default

Destructor.

Member Function Documentation

◆ operator=() [1/2]

Bitmap & yaze::gfx::Bitmap::operator= ( const Bitmap & other )

Copy assignment operator.

Definition at line 88 of file bitmap.cc.

References active_, yaze::gfx::Arena::AllocateSurface(), CopySurfaceState(), data_, depth_, yaze::gfx::Arena::DESTROY, yaze::gfx::Arena::FreeSurface(), generation_, yaze::gfx::Arena::Get(), yaze::gfx::GetSnesPixelFormat(), height_, yaze::gfx::kIndexed, yaze::gfx::kRgba, metadata_, modified_, next_generation_, palette_, pixel_data_, yaze::gfx::Arena::QueueTextureCommand(), surface_, texture_, UpdateSurfacePixels(), and width_.

◆ operator=() [2/2]

Bitmap & yaze::gfx::Bitmap::operator= ( Bitmap && other )

noexcept

Move assignment operator.

Definition at line 157 of file bitmap.cc.

References yaze::gfx::Arena::FreeSurface(), and yaze::gfx::Arena::Get().

Here is the call graph for this function:

◆ Create() [1/3]

void yaze::gfx::Bitmap::Create	(	int	width,
		int	height,
		int	depth,
		std::span< uint8_t >	data )

Create a bitmap with the given dimensions and data.

Definition at line 198 of file bitmap.cc.

References Create(), data(), data_, depth(), height(), and width().

◆ Create() [2/3]

void yaze::gfx::Bitmap::Create	(	int	width,
		int	height,
		int	depth,
		const std::vector< uint8_t > &	data )

Create a bitmap with the given dimensions and data.

Definition at line 203 of file bitmap.cc.

References Create(), data(), depth(), height(), yaze::gfx::kIndexed, yaze::gfx::kRgba, and width().

◆ Create() [3/3]

void yaze::gfx::Bitmap::Create	(	int	width,
		int	height,
		int	depth,
		int	format,
		const std::vector< uint8_t > &	data )

Create a bitmap with the given dimensions, format, and data.

Create a bitmap with specified format and data.

Parameters

width	Width in pixels
height	Height in pixels
depth	Color depth in bits per pixel
format	Pixel format (0=indexed, 1=4BPP, 2=8BPP)
data	Raw pixel data

Performance Notes:

Uses Arena for efficient surface allocation
Copies data to avoid external pointer dependencies
Validates data size against surface dimensions
Sets active flag for rendering pipeline

Definition at line 223 of file bitmap.cc.

References active_, yaze::gfx::Arena::AllocateSurface(), ApplyStoredPalette(), data(), data_, depth(), depth_, yaze::gfx::SnesPalette::empty(), yaze::platform::EnsureSurfacePalette256(), yaze::gfx::Arena::FreeSurface(), generation_, yaze::gfx::Arena::Get(), yaze::gfx::GetSnesPixelFormat(), height(), height_, IsIndexed(), yaze::gfx::kIndexed, next_generation_, palette_, pixel_data_, surface_, UpdateSurfacePixels(), vector(), width(), and width_.

◆ Reformat()

void yaze::gfx::Bitmap::Reformat ( int format )

Reformat the bitmap to use a different pixel format.

Definition at line 280 of file bitmap.cc.

References active_, yaze::gfx::Arena::AllocateSurface(), data_, depth_, yaze::gfx::Arena::Get(), yaze::gfx::GetSnesPixelFormat(), height_, palette_, pixel_data_, SetPalette(), surface_, vector(), and width_.

Referenced by yaze::editor::internal::EnsureSpritePreviewBitmapReady(), and yaze::gui::CanvasContextMenu::RenderBitmapOperationsMenu().

◆ Fill()

void yaze::gfx::Bitmap::Fill ( uint8_t value )

inline

Fill the bitmap with a specific value.

Definition at line 146 of file bitmap.h.

References data_, and modified_.

Referenced by yaze::zelda3::RoomLayerManager::CompositeToOutput().

◆ CreateTexture()

void yaze::gfx::Bitmap::CreateTexture ( )

Creates the underlying SDL_Texture to be displayed.

Definition at line 297 of file bitmap.cc.

References yaze::gfx::Arena::CREATE, yaze::gfx::Arena::Get(), and yaze::gfx::Arena::QueueTextureCommand().

Referenced by yaze::gfx::AtlasRenderer::AddBitmapWithBppOptimization(), yaze::editor::internal::EnsureSpritePreviewBitmapReady(), yaze::editor::ObjectTileEditorPanel::RenderObjectPreview(), yaze::editor::ObjectTileEditorPanel::RenderTile8Atlas(), yaze::gfx::RenderTilesBatch(), and yaze::editor::SyncMapBrushPreview().

Here is the call graph for this function:

◆ UpdateTexture()

void yaze::gfx::Bitmap::UpdateTexture ( )

Updates the underlying SDL_Texture when it already exists.

Definition at line 301 of file bitmap.cc.

References yaze::gfx::Arena::Get(), yaze::gfx::Arena::QueueTextureCommand(), and yaze::gfx::Arena::UPDATE.

Referenced by yaze::gui::Canvas::ConvertBitmapFormat(), yaze::editor::GfxGroupEditor::PrepareSheetPreview(), yaze::editor::internal::PublishSpritePreviewPixels(), yaze::editor::ObjectTileEditorPanel::RenderObjectPreview(), yaze::editor::ObjectTileEditorPanel::RenderTile8Atlas(), yaze::editor::SyncMapBrushPreview(), yaze::editor::internal::SyncSheetPreview(), and yaze::gui::Canvas::UpdateColorPainter().

Here is the call graph for this function:

◆ QueueTextureUpdate()

void yaze::gfx::Bitmap::QueueTextureUpdate ( IRenderer * renderer )

Queue texture update for batch processing (improved performance)

Parameters

renderer SDL renderer for texture operations

Note: Use this for better performance when multiple textures need updating

◆ UpdateTextureData()

void yaze::gfx::Bitmap::UpdateTextureData ( )

Updates the texture data from the surface.

◆ SetPalette() [1/2]

void yaze::gfx::Bitmap::SetPalette ( const SnesPalette & palette )

Set the palette for the bitmap using SNES palette format.

This method stores the palette in the internal palette_ member AND applies it to the SDL surface via ApplyStoredPalette().

Note: IMPORTANT: There are two palette storage mechanisms in Bitmap:

**Internal SnesPalette (palette_ member)**: Stores the SNES color format for serialization and palette editing. Accessible via palette().
**SDL Surface Palette (surface_->format->palette)**: Used by SDL for actual rendering. When converting indexed pixels to RGBA for textures, SDL uses THIS palette, not the internal one.

Both are updated when calling SetPalette(SnesPalette). However, some code paths (like dungeon room rendering) use SetPalette(vector<SDL_Color>) which ONLY sets the SDL surface palette, leaving the internal palette_ empty.

When compositing bitmaps or copying palettes between bitmaps, you may need to extract the palette from the SDL surface directly rather than using palette() which may be empty. See RoomLayerManager::CompositeToOutput() for an example of proper palette extraction from SDL surfaces.

Parameters

palette SNES palette to apply (15-bit RGB format)

See also: SetPalette(const std::vector<SDL_Color>&) for direct SDL palette access

Definition at line 452 of file bitmap.cc.

References ApplyStoredPalette(), modified_, palette(), and palette_.

Referenced by yaze::editor::MessageEditor::ApplyFontPalette(), ApplyPaletteByMetadata(), yaze::gui::CanvasUtils::ApplyPaletteGroup(), yaze::editor::Tile16EditSession::ApplyPaletteToCurrentTile16Bitmap(), yaze::editor::internal::ApplyRoleDefaultPalette(), yaze::gui::PaletteEditorWidget::ApplyROMPalette(), yaze::editor::anonymous_namespace{tile_object_handler.cc}::ApplyRoomPaletteToGhost(), yaze::zelda3::anonymous_namespace{room_layer_manager.cc}::ApplySDLPaletteToBitmap(), Bitmap(), yaze::editor::Tile16EditSession::BuildStampPreview(), yaze::zelda3::ObjectTileEditor::BuildTile8Atlas(), yaze::zelda3::Inventory::BuildTileset(), yaze::zelda3::TitleScreen::BuildTileset(), CopySurfaceState(), yaze::editor::Tile16EditSession::CopyTile16ToClipboard(), yaze::zelda3::OverworldMapScreen::Create(), yaze::zelda3::Inventory::Create(), yaze::gfx::CreateTilemap(), yaze::editor::GraphicsEditor::DecompressImportData(), yaze::editor::GraphicsEditor::DrawCgxImport(), yaze::editor::ScreenEditor::DrawDungeonMapScreen(), yaze::editor::ScreenEditor::DrawDungeonMapsRoomGfx(), yaze::editor::MenuTilemapEditorUI::DrawOverlayControls(), yaze::editor::OverworldEditor::DrawScratchSpace(), yaze::editor::GraphicsEditor::DrawScrImport(), yaze::editor::Tile16Editor::DrawTile16EditorWorkbenchColumn(), yaze::editor::Tile16EditSession::DrawToCurrentTile16Impl(), yaze::gfx::BackgroundBuffer::EnsureBitmapInitialized(), yaze::editor::Tile16EditSession::InitializeBitmaps(), yaze::editor::ScreenEditor::Load(), yaze::zelda3::LoadDungeonMapTile16(), yaze::editor::OverworldEditor::LoadGraphics(), yaze::editor::Tile16EditSession::LoadTile16FromScratchSpaceImpl(), yaze::zelda3::TitleScreen::LoadTitleScreen(), yaze::editor::Tile16EditSession::PasteTile16FromClipboardImpl(), yaze::editor::GfxGroupEditor::PrepareSheetPreview(), yaze::editor::Tile16EditSession::PreviewPaletteChange(), yaze::editor::MenuTilemapEditorUI::RebuildRenderTextures(), yaze::editor::OverworldEditor::RebuildScratchBitmapFromTileData(), Reformat(), yaze::editor::Tile16EditSession::RefreshAllPalettes(), yaze::editor::ScreenEditor::RefreshDungeonMapGraphicsFromSession(), yaze::editor::MessageEditor::RefreshFontAtlasBitmap(), yaze::editor::MapRefreshCoordinator::RefreshTile16Blockset(), yaze::zelda3::ObjectTileEditor::RenderLayoutToBitmap(), yaze::editor::SpriteEditor::RenderVanillaSprite(), yaze::editor::SpriteEditor::RenderZSpriteFrame(), yaze::test::RomDependentTestSuite::RunTile16EditorTest(), yaze::editor::OverworldEditor::SaveCurrentSelectionToScratch(), yaze::editor::UsagePreviewView::ShowImage(), yaze::editor::SyncMapBrushPreview(), yaze::editor::internal::SyncSheetPreview(), yaze::editor::Tile16EditSession::UpdateLivePreview(), and yaze::editor::Tile16EditSession::UpdateTile8Palette().

Here is the call graph for this function:

◆ SetPaletteWithTransparent()

void yaze::gfx::Bitmap::SetPaletteWithTransparent	(	const SnesPalette &	palette,
		size_t	index,
		int	length = 7 )

Set the palette with a transparent color.

Apply a sub-palette with automatic transparency for SNES rendering.

This method extracts a sub-palette from a larger palette and applies it to the SDL surface with proper SNES transparency handling.

SNES Transparency Model:

The SNES hardware automatically treats palette index 0 as transparent
This is a hardware feature, not stored in ROM data
This method creates a transparent color 0 for proper SNES emulation

Usage:

Extract 8-color sub-palette from position 'index' in source palette
Color 0: Always set to transparent black (0,0,0,0)
Colors 1-7: Taken from palette[index] through palette[index+6]
If palette has fewer than 7 colors, fills with opaque black

Example: palette has colors [c0, c1, c2, c3, c4, c5, c6, c7, c8, ...] SetPaletteWithTransparent(palette, 0, 7) creates: [transparent_black, c0, c1, c2, c3, c4, c5, c6]

IMPORTANT: Source palette data is NOT modified

The full palette is stored in palette_ member for reference
Only the SDL surface palette is updated with the 8-color subset
This allows proper palette editing while maintaining SNES rendering

Parameters

palette	Source palette (can be 7, 8, 64, 128, or 256 colors)
index	Start index in source palette (0-based)
length	Number of colors to extract (default 7, max 7)

Definition at line 524 of file bitmap.cc.

References yaze::platform::GetSurfacePalette(), InvalidatePaletteCache(), palette(), palette_, yaze::gfx::SnesPalette::size(), surface_, and vector().

Referenced by yaze::zelda3::anonymous_namespace{game_data.cc}::ApplyDefaultPalette(), ApplyPaletteByMetadata(), yaze::gui::CanvasUtils::ApplyPaletteGroup(), yaze::editor::Tile16EditSession::ApplyPaletteToCurrentTile16Bitmap(), yaze::gui::PaletteEditorWidget::ApplyROMPalette(), yaze::editor::PixelEditorPanel::DisplaySheet(), yaze::editor::Tile16EditSession::PreviewPaletteChange(), and yaze::editor::Tile16EditSession::UpdateLivePreview().

◆ ApplyPaletteByMetadata()

void yaze::gfx::Bitmap::ApplyPaletteByMetadata	(	const SnesPalette &	palette,
		int	sub_palette_index = 0 )

Apply palette using metadata-driven strategy Chooses between SetPalette and SetPaletteWithTransparent based on metadata.

Apply palette using metadata-driven strategy.

Uses bitmap metadata to determine the appropriate palette application method:

palette_format == 0: Full palette (SetPalette)
palette_format == 1: Sub-palette with transparent color 0 (SetPaletteWithTransparent)

This ensures correct rendering for different bitmap types:

3BPP graphics sheets → sub-palette with transparent
4BPP full palettes → full palette
Mode 7 graphics → full palette

Parameters

palette	Source palette to apply
sub_palette_index	Index within palette for sub-palette extraction (default 0)

Definition at line 480 of file bitmap.cc.

References metadata_, palette(), yaze::gfx::Bitmap::BitmapMetadata::palette_format, SetPalette(), SetPaletteWithTransparent(), and vector().

Here is the call graph for this function:

◆ ApplyStoredPalette()

void yaze::gfx::Bitmap::ApplyStoredPalette ( )

Apply the stored palette to the surface (internal helper)

Apply the stored palette to the SDL surface.

This method applies the palette_ member to the SDL surface's palette.

IMPORTANT: Transparency handling

ROM palette data does NOT have transparency flags set
Transparency is only applied if explicitly marked (via set_transparent)
For SNES rendering, use SetPaletteWithTransparent which creates transparent color 0 automatically
This method preserves the transparency state of each color

Color format notes:

SnesColor.rgb() returns 0-255 values stored in ImVec4 (unconventional!)
We cast these directly to Uint8 for SDL

Definition at line 321 of file bitmap.cc.

References yaze::gfx::SnesPalette::empty(), yaze::platform::GetSurfacePalette(), InvalidatePaletteCache(), IsIndexed(), palette_, yaze::gfx::SnesPalette::size(), surface_, and vector().

Referenced by Create(), and SetPalette().

◆ UpdateSurfacePixels()

void yaze::gfx::Bitmap::UpdateSurfacePixels ( )

Update SDL surface with current pixel data from data_ vector Call this after modifying pixel data via mutable_data()

Definition at line 373 of file bitmap.cc.

References data_, height_, IsIndexed(), surface_, vector(), and width_.

Referenced by Bitmap(), yaze::zelda3::ObjectTileEditor::BuildTile8Atlas(), yaze::zelda3::RoomLayerManager::CompositeToOutput(), Create(), yaze::editor::Tile16Editor::DrawTile16EditorWorkbenchColumn(), operator=(), yaze::editor::internal::PublishSpritePreviewPixels(), yaze::zelda3::TitleScreen::RenderBG1Layer(), yaze::zelda3::TitleScreen::RenderBG2Layer(), yaze::zelda3::TitleScreen::RenderCompositeLayer(), yaze::zelda3::ObjectTileEditor::RenderLayoutToBitmap(), yaze::zelda3::OverworldMapScreen::RenderMapLayer(), and set_data().

Here is the call graph for this function:

◆ SetPalette() [2/2]

void yaze::gfx::Bitmap::SetPalette ( const std::vector< SDL_Color > & palette )

Set the palette using SDL colors (direct surface palette access)

This method ONLY sets the SDL surface palette for rendering. It does NOT update the internal palette_ member (SnesPalette).

Use this method when:

You have pre-converted colors in SDL_Color format
You're copying a palette from another SDL surface
Performance is critical (avoids SNES→SDL color conversion)
You don't need to preserve the palette for serialization

Warning: After calling this method, palette() will return an empty or stale SnesPalette. If you need to copy the palette to another bitmap, extract it from the SDL surface directly:

SDL_Palette* pal = src_bitmap.surface()->format->palette;
std::vector<SDL_Color> colors(pal->colors, pal->colors + pal->ncolors);
dst_bitmap.SetPalette(colors);

Parameters

palette Vector of SDL_Color values (256 colors for 8-bit indexed)

See also: SetPalette(const SnesPalette&) for full palette storage

Definition at line 603 of file bitmap.cc.

References yaze::platform::EnsureSurfacePalette256(), yaze::platform::GetSurfacePalette(), InvalidatePaletteCache(), IsIndexed(), modified_, palette(), yaze::gfx::SnesPalette::size(), surface_, and vector().

◆ WriteToPixel() [1/2]

void yaze::gfx::Bitmap::WriteToPixel	(	int	position,
		uint8_t	value )

Write a value to a pixel at the given position.

Definition at line 649 of file bitmap.cc.

References active_, data_, IsIndexed(), modified_, pixel_data_, surface_, vector(), and width_.

Referenced by yaze::gfx::anonymous_namespace{tilemap.cc}::ComposeAndPlaceTilePart(), yaze::editor::OverworldEditor::UpdateScratchBitmapTile(), WriteColor(), and WriteToPixel().

Here is the call graph for this function:

◆ WriteToPixel() [2/2]

void yaze::gfx::Bitmap::WriteToPixel	(	int	x,
		int	y,
		uint8_t	value )

inline

Write a palette index to a pixel at the given x,y coordinates.

Parameters

x	X coordinate (0 to width-1)
y	Y coordinate (0 to height-1)
value	Palette index (0-255)

Definition at line 265 of file bitmap.h.

References height_, vector(), width_, and WriteToPixel().

Here is the call graph for this function:

◆ GetPixel()

uint8_t yaze::gfx::Bitmap::GetPixel	(	int	x,
		int	y ) const

inline

Get the palette index at the given x,y coordinates.

Parameters

x	X coordinate (0 to width-1)
y	Y coordinate (0 to height-1)

Returns: Palette index at the position, or 0 if out of bounds

Definition at line 277 of file bitmap.h.

References data_, height_, vector(), and width_.

Referenced by yaze::editor::PixelEditorPanel::DrawPixelInfoTooltip().

Here is the call graph for this function:

◆ WriteColor()

void yaze::gfx::Bitmap::WriteColor	(	int	position,
		const ImVec4 &	color )

Write a color to a pixel at the given position.

Definition at line 705 of file bitmap.cc.

References IsIndexed(), yaze::platform::MapRGB(), surface_, vector(), and WriteToPixel().

Referenced by yaze::gui::Canvas::DrawTileOnBitmap().

Here is the call graph for this function:

◆ SetPixel()

void yaze::gfx::Bitmap::SetPixel	(	int	x,
		int	y,
		const SnesColor &	color )

Set a pixel at the given x,y coordinates with SNES color.

Set a pixel at the given coordinates with SNES color.

Parameters

x	X coordinate (0 to width-1)
y	Y coordinate (0 to height-1)
color	SNES color (15-bit RGB format)

Note: Automatically finds closest palette index and marks bitmap as modified

Parameters

x	X coordinate (0 to width-1)
y	Y coordinate (0 to height-1)
color	SNES color (15-bit RGB format)

Performance Notes:

Bounds checking for safety
O(1) palette lookup using hash map cache (100x faster than linear search)
Dirty region tracking for efficient texture updates
Direct pixel data manipulation for speed

Optimizations Applied:

Hash map palette lookup instead of linear search
Dirty region tracking to minimize texture update area

Definition at line 766 of file bitmap.cc.

References yaze::gfx::Bitmap::DirtyRegion::AddPoint(), data_, dirty_region_, FindColorIndex(), height_, IsIndexed(), modified_, pixel_data_, surface_, vector(), and width_.

Referenced by yaze::cli::Tile16ProposalGenerator::GenerateDiff(), yaze::zelda3::DungeonObjectEditor::RenderLayerVisualization(), and yaze::zelda3::DungeonObjectEditor::RenderSelectionHighlight().

Here is the call graph for this function:

◆ Resize()

void yaze::gfx::Bitmap::Resize	(	int	new_width,
		int	new_height )

Resize the bitmap to new dimensions (preserves existing data)

Parameters

new_width	New width in pixels
new_height	New height in pixels

Note: Expands with black pixels, crops excess data

Definition at line 798 of file bitmap.cc.

References active_, yaze::gfx::Arena::AllocateSurface(), data_, depth_, yaze::gfx::Arena::Get(), yaze::gfx::GetSnesPixelFormat(), height_, IsIndexed(), yaze::gfx::kIndexed, yaze::gfx::kRgba, modified_, pixel_data_, surface_, vector(), and width_.

◆ InvalidatePaletteCache()

void yaze::gfx::Bitmap::InvalidatePaletteCache ( )

Invalidate the palette lookup cache (call when palette changes)

Note: This must be called whenever the palette is modified to maintain cache consistency; This must be called whenever the palette is modified to maintain cache consistency

Performance Notes:

Clears existing cache to force rebuild
Rebuilds cache with current palette colors
O(n) operation but only called when palette changes

Definition at line 873 of file bitmap.cc.

References color_to_index_cache_, HashColor(), palette_, yaze::gfx::SnesPalette::size(), and vector().

Referenced by ApplyStoredPalette(), SetPalette(), and SetPaletteWithTransparent().

Here is the call graph for this function:

◆ FindColorIndex()

uint8_t yaze::gfx::Bitmap::FindColorIndex ( const SnesColor & color )

Find color index in palette using optimized hash map lookup.

Parameters

color SNES color to find index for

Returns: Palette index (0 if not found)

Note: O(1) lookup time vs O(n) linear search

Parameters

color SNES color to find index for

Returns: Palette index (0 if not found)

Note: O(1) lookup time vs O(n) linear search

Performance Notes:

Hash map lookup for O(1) performance
100x faster than linear search for large palettes
Falls back to index 0 if color not found

Definition at line 894 of file bitmap.cc.

References color_to_index_cache_, HashColor(), yaze::gfx::SnesColor::rgb(), and vector().

Referenced by SetPixel().

Here is the call graph for this function:

◆ ValidateDataSurfaceSync()

bool yaze::gfx::Bitmap::ValidateDataSurfaceSync ( )

Validate that bitmap data and surface pixels are synchronized.

Returns: true if synchronized, false if there are issues

Note: This method helps debug surface synchronization problems

Definition at line 916 of file bitmap.cc.

References data_, height_, IsIndexed(), surface_, vector(), and width_.

Here is the call graph for this function:

◆ Get8x8Tile()

void yaze::gfx::Bitmap::Get8x8Tile	(	int	tile_index,
		int	x,
		int	y,
		std::vector< uint8_t > &	tile_data,
		int &	tile_data_offset )

Extract an 8x8 tile from the bitmap (SNES standard tile size)

Parameters

tile_index	Index of the tile in the tilesheet
x	X offset within the tile (0-7)
y	Y offset within the tile (0-7)
tile_data	Output buffer for tile pixel data (64 bytes for 8x8)
tile_data_offset	Current offset in tile_data buffer

Note: Used for ROM tile editing and tile extraction

Definition at line 716 of file bitmap.cc.

References data_, height_, vector(), and width_.

Here is the call graph for this function:

◆ Get16x16Tile()

void yaze::gfx::Bitmap::Get16x16Tile	(	int	tile_x,
		int	tile_y,
		std::vector< uint8_t > &	tile_data,
		int &	tile_data_offset )

Extract a 16x16 tile from the bitmap (SNES metatile size)

Parameters

tile_x	X coordinate of tile in tilesheet
tile_y	Y coordinate of tile in tilesheet
tile_data	Output buffer for tile pixel data (256 bytes for 16x16)
tile_data_offset	Current offset in tile_data buffer

Note: Used for ROM metatile editing and large tile extraction

Definition at line 732 of file bitmap.cc.

References data_, vector(), and width_.

Referenced by yaze::editor::ScreenEditor::DrawDungeonMapScreen(), and yaze::gfx::UpdateTile16().

Here is the call graph for this function:

◆ palette()

const SnesPalette & yaze::gfx::Bitmap::palette ( ) const

inline

Definition at line 393 of file bitmap.h.

References palette_.

◆ mutable_palette()

SnesPalette * yaze::gfx::Bitmap::mutable_palette ( )

inline

Definition at line 394 of file bitmap.h.

References palette_.

Referenced by yaze::gui::Canvas::DrawContextMenu(), yaze::editor::MessageEditor::Initialize(), yaze::gui::CanvasContextMenu::RenderPaletteOperationsMenu(), and yaze::gui::Canvas::ShowPaletteEditor().

◆ metadata() [1/2]

BitmapMetadata & yaze::gfx::Bitmap::metadata ( )

inline

Definition at line 395 of file bitmap.h.

References metadata_.

Referenced by yaze::zelda3::RoomLayerManager::CompositeToOutput(), yaze::zelda3::OverworldMapScreen::Create(), yaze::zelda3::TitleScreen::Create(), yaze::gfx::EnsureCompositeBitmapTextureQueued(), yaze::editor::internal::EnsureSheetTextureQueued(), yaze::editor::internal::EnsureSpritePreviewBitmapReady(), yaze::gui::anonymous_namespace{canvas_rendering.cc}::LogBitmapDropIfDebug(), yaze::gui::CanvasContextMenu::RenderPaletteOperationsMenu(), and yaze::editor::UsagePreviewView::ShowImage().

◆ metadata() [2/2]

const BitmapMetadata & yaze::gfx::Bitmap::metadata ( ) const

inline

Definition at line 396 of file bitmap.h.

References metadata_.

◆ width()

int yaze::gfx::Bitmap::width ( ) const

inline

Definition at line 398 of file bitmap.h.

References width_.

◆ height()

int yaze::gfx::Bitmap::height ( ) const

inline

Definition at line 399 of file bitmap.h.

References height_.

Referenced by yaze::gfx::AtlasRenderer::AddBitmap(), yaze::gfx::AtlasRenderer::AddBitmapWithBppOptimization(), yaze::editor::Tile16EditSession::AnalyzeTile8SourceData(), Bitmap(), Bitmap(), yaze::app::service::RenderService::BitmapToRgba(), yaze::gui::BppComparisonTool::CalculateMetrics(), yaze::zelda3::RoomLayerManager::CompositeToOutput(), yaze::zelda3::ComputeTile16Count(), yaze::gui::Canvas::ConvertBitmapFormat(), Create(), Create(), Create(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::DrawBitmap(), yaze::editor::UsagePreviewView::DrawBitmapFit(), yaze::gui::Canvas::DrawBitmapGroup(), yaze::gui::DrawBitmapPreview(), yaze::gui::DrawBitmapViewer(), yaze::editor::ScreenEditor::DrawDungeonMapScreen(), yaze::editor::ScreenEditor::DrawDungeonMapsRoomGfx(), yaze::gfx::BackgroundBuffer::DrawFloor(), yaze::editor::PixelEditorPanel::DrawPixelInfoTooltip(), yaze::editor::SheetBrowserPanel::DrawSheetThumbnail(), yaze::editor::Tile16Editor::DrawTile8SourcePanel(), yaze::editor::SpriteDrawer::DrawTile8x8(), yaze::gui::DrawTilemapPainter(), yaze::gui::CanvasInteractionHandler::DrawTilemapPainter(), yaze::zelda3::ObjectDrawer::DrawTileToBitmap(), yaze::gui::BppComparisonTool::GenerateComparisons(), yaze::gui::Canvas::GetCurrentBppFormat(), yaze::gfx::GetTilemapData(), yaze::editor::Tile16EditSession::LoadTile8(), yaze::gui::anonymous_namespace{canvas_rendering.cc}::LogBitmapDropIfDebug(), yaze::gfx::AtlasRenderer::PackBitmap(), yaze::gfx::TextureAtlas::PackBitmap(), yaze::gui::TileSelectorWidget::Render(), yaze::gui::CanvasModals::RenderAdvancedPropertiesModal(), yaze::gui::BppFormatUI::RenderAnalysisPanel(), yaze::gui::RenderBitmapGroup(), yaze::gui::RenderBitmapOnCanvas(), yaze::gui::RenderBitmapOnCanvas(), yaze::gui::RenderBitmapOnCanvas(), yaze::gui::CanvasContextMenu::RenderBitmapOperationsMenu(), yaze::gui::BppFormatUI::RenderConversionPreview(), yaze::gui::BppFormatUI::RenderFormatSelector(), yaze::zelda3::DungeonObjectEditor::RenderLayerVisualization(), yaze::gui::RenderPreviewPanel(), yaze::gui::CanvasModals::RenderScalingControlsModal(), yaze::zelda3::DungeonObjectEditor::RenderSelectionHighlight(), yaze::gfx::RenderTile16(), yaze::zelda3::PaletteDebugger::SamplePixelAt(), yaze::gui::Canvas::SetZoomToFit(), yaze::gui::Canvas::ShowAdvancedCanvasProperties(), yaze::gui::PaletteEditorWidget::ShowColorAnalysis(), yaze::editor::UsagePreviewView::ShowImage(), yaze::gui::Canvas::ShowScalingControls(), yaze::editor::usage_preview::SnapshotBitmap(), yaze::editor::anonymous_namespace{map_refresh_coordinator.cc}::SyncCurrentGraphicsBitmapForTile16Editor(), yaze::zelda3::anonymous_namespace{object_drawer.cc}::SyncModifiedBitmapToSurface(), yaze::editor::internal::SyncSheetPreview(), yaze::gui::TableCanvasPipeline(), yaze::gfx::AtlasRenderer::UpdateBitmap(), yaze::editor::MapRefreshCoordinator::UpdateBlocksetWithPendingTileChanges(), yaze::gui::BppConversionDialog::UpdatePreview(), and yaze::editor::OverworldEditor::UpdateScratchBitmapTile().

◆ depth()

int yaze::gfx::Bitmap::depth ( ) const

inline

Definition at line 400 of file bitmap.h.

References depth_.

Referenced by yaze::gfx::AtlasRenderer::AddBitmapWithBppOptimization(), yaze::editor::Tile16EditSession::AnalyzeTile8SourceData(), Bitmap(), Bitmap(), yaze::zelda3::RoomLayerManager::CompositeToOutput(), Create(), Create(), Create(), yaze::editor::SheetBrowserPanel::DrawSheetThumbnail(), yaze::gui::BppComparisonTool::GenerateComparisons(), yaze::gui::BppFormatUI::RenderConversionPreview(), yaze::editor::UsagePreviewView::ShowImage(), yaze::editor::anonymous_namespace{map_refresh_coordinator.cc}::SyncCurrentGraphicsBitmapForTile16Editor(), yaze::zelda3::anonymous_namespace{object_drawer.cc}::SyncModifiedBitmapToSurface(), yaze::editor::internal::SyncSheetPreview(), and yaze::gui::BppConversionDialog::UpdatePreview().

◆ IsIndexed()

bool yaze::gfx::Bitmap::IsIndexed ( ) const

inline

◆ ReadColor()

SDL_Color yaze::gfx::Bitmap::ReadColor	(	int	x,
		int	y ) const

Definition at line 414 of file bitmap.cc.

References data_, yaze::platform::GetSurfacePalette(), height_, IsIndexed(), palette(), surface_, vector(), and width_.

Referenced by yaze::app::service::RenderService::BitmapToRgba(), yaze::zelda3::PaletteDebugger::SamplePixelAt(), and ToRgba().

Here is the call graph for this function:

◆ ToRgba()

std::vector< uint8_t > yaze::gfx::Bitmap::ToRgba ( ) const

Definition at line 435 of file bitmap.cc.

References height_, ReadColor(), and width_.

Here is the call graph for this function:

◆ size()

auto yaze::gfx::Bitmap::size ( ) const

inline

Definition at line 406 of file bitmap.h.

References data_.

Referenced by yaze::editor::Tile16EditSession::AnalyzeTile8SourceData(), yaze::editor::Tile16EditSession::BitmapHasEncodedPaletteRows(), yaze::zelda3::BlitTile16BitmapToAtlas(), yaze::editor::ScreenEditor::DrawDungeonMapsRoomGfx(), yaze::editor::Tile16EditSession::LoadTile8(), yaze::zelda3::RenderTile16PixelsFromMetadata(), yaze::zelda3::PaletteDebugger::SamplePixelAt(), and yaze::zelda3::anonymous_namespace{object_drawer.cc}::SyncModifiedBitmapToSurface().

◆ data()

const uint8_t * yaze::gfx::Bitmap::data ( ) const

inline

Definition at line 407 of file bitmap.h.

References data_.

Referenced by yaze::editor::Tile16EditSession::AnalyzeTile8SourceData(), Bitmap(), Bitmap(), yaze::editor::Tile16EditSession::BitmapHasEncodedPaletteRows(), yaze::zelda3::BlitTile16BitmapToAtlas(), Create(), Create(), Create(), yaze::editor::ScreenEditor::DrawDungeonMapsRoomGfx(), yaze::editor::Tile16EditSession::LoadTile8(), yaze::editor::ObjectTileEditorPanel::RenderObjectPreview(), yaze::zelda3::RenderTile16PixelsFromMetadata(), yaze::editor::ObjectTileEditorPanel::RenderTile8Atlas(), yaze::zelda3::PaletteDebugger::SamplePixelAt(), set_data(), and yaze::zelda3::anonymous_namespace{object_drawer.cc}::SyncModifiedBitmapToSurface().

◆ mutable_data()

std::vector< uint8_t > & yaze::gfx::Bitmap::mutable_data ( )

inline

Definition at line 408 of file bitmap.h.

References data_.

Referenced by yaze::zelda3::TitleScreen::BuildTileset(), yaze::editor::SpriteDrawer::ClearBitmap(), yaze::editor::OverworldEditor::ClearScratchSpace(), yaze::zelda3::RoomLayerManager::CompositeToOutput(), yaze::gfx::BackgroundBuffer::DrawBackground(), yaze::editor::Tile16Editor::DrawTile16EditorWorkbenchColumn(), yaze::editor::SpriteDrawer::DrawTile8x8(), yaze::zelda3::ObjectDrawer::DrawTileToBitmap(), yaze::zelda3::TitleScreen::RenderBG1Layer(), yaze::zelda3::TitleScreen::RenderBG2Layer(), yaze::zelda3::TitleScreen::RenderCompositeLayer(), yaze::zelda3::OverworldMapScreen::RenderMapLayer(), yaze::gui::DungeonObjectEmulatorPreview::TriggerStaticRender(), and yaze::editor::MapRefreshCoordinator::UpdateBlocksetWithPendingTileChanges().

◆ surface()

SDL_Surface * yaze::gfx::Bitmap::surface ( ) const

inline

Definition at line 409 of file bitmap.h.

References surface_.

Referenced by yaze::editor::anonymous_namespace{tile_object_handler.cc}::ApplyRoomPaletteToGhost(), yaze::app::service::RenderService::BitmapToRgba(), yaze::zelda3::ObjectTileEditor::BuildTile8Atlas(), yaze::zelda3::RoomLayerManager::CompositeToOutput(), yaze::gfx::CreateTilemap(), DetachSurfaceForArena(), yaze::gfx::BackgroundBuffer::DrawBackground(), yaze::gui::DrawBitmap(), yaze::gui::DrawBitmapPreview(), yaze::gfx::BackgroundBuffer::EnsureBitmapInitialized(), yaze::gfx::EnsureCompositeBitmapTextureQueued(), yaze::editor::internal::EnsureSheetTextureQueued(), yaze::editor::internal::EnsureSpritePreviewBitmapReady(), yaze::editor::OverworldEditor::LoadGraphics(), yaze::editor::GfxGroupEditor::PrepareSheetPreview(), yaze::gui::CanvasContextMenu::RenderBitmapOperationsMenu(), yaze::zelda3::ObjectTileEditor::RenderLayoutToBitmap(), yaze::gui::RenderPreviewPanel(), yaze::gfx::RenderTilesBatch(), yaze::zelda3::PaletteDebugger::SamplePixelAt(), yaze::editor::usage_preview::SnapshotBitmap(), yaze::zelda3::anonymous_namespace{object_drawer.cc}::SyncModifiedBitmapToSurface(), yaze::editor::internal::SyncSheetPreview(), yaze::gfx::MetalRenderer::UpdateTexture(), yaze::gfx::SDL2Renderer::UpdateTexture(), and yaze::gfx::UpdateTilemap().

◆ texture()

TextureHandle yaze::gfx::Bitmap::texture ( ) const

inline

Definition at line 410 of file bitmap.h.

References texture_.

Referenced by yaze::gfx::AtlasRenderer::AddBitmap(), yaze::gfx::AtlasRenderer::AddBitmapWithBppOptimization(), yaze::editor::OverworldEditor::AreaScreenBitmap(), DetachTextureForArena(), yaze::editor::PixelEditorPanel::DisplaySheet(), yaze::gui::DrawBitmap(), yaze::editor::UsagePreviewView::DrawBitmapFit(), yaze::gui::Canvas::DrawBitmapGroup(), yaze::gui::DrawBitmapPreview(), yaze::gui::DrawBitmapViewer(), yaze::editor::DungeonCanvasViewer::DrawConnectedRoomMatrix(), yaze::editor::DungeonCanvasViewer::DrawRoomBackgroundLayers(), yaze::editor::ObjectTileEditorPanel::DrawSourceSheet(), yaze::editor::Tile16Editor::DrawTile16EditorWorkbenchColumn(), yaze::editor::ObjectTileEditorPanel::DrawTileGrid(), yaze::gui::DrawTilemapPainter(), yaze::gui::CanvasInteractionHandler::DrawTilemapPainter(), yaze::gui::Canvas::DrawTilePainter(), yaze::gui::CanvasInteractionHandler::DrawTilePainter(), yaze::gfx::EnsureCompositeBitmapTextureQueued(), yaze::editor::MessageEditor::EnsureFontTexturesReady(), yaze::editor::internal::EnsureSheetTextureQueued(), yaze::gfx::Arena::GetSheetWithCache(), yaze::gui::HandleTilePaintWithPreview(), yaze::editor::GfxGroupEditor::PrepareSheetPreview(), yaze::editor::anonymous_namespace{usage_preview_view.cc}::QueueTexture(), yaze::editor::MapRefreshCoordinator::RefreshTile16Blockset(), yaze::gui::TileSelectorWidget::Render(), yaze::gui::RenderBitmapGroup(), yaze::gui::RenderBitmapOnCanvas(), yaze::gui::RenderBitmapOnCanvas(), yaze::gui::RenderBitmapOnCanvas(), yaze::gui::BppComparisonTool::RenderComparisonGrid(), yaze::gui::BppFormatUI::RenderConversionPreview(), yaze::editor::ObjectTileEditorPanel::RenderObjectPreview(), yaze::gui::BppConversionDialog::RenderPreview(), yaze::gui::RenderPreviewPanel(), yaze::editor::ObjectTileEditorPanel::RenderTile8Atlas(), yaze::gfx::RenderTilesBatch(), yaze::gfx::Arena::RetireBitmap(), set_texture(), yaze::editor::anonymous_namespace{map_refresh_coordinator.cc}::SyncCurrentGraphicsBitmapForTile16Editor(), yaze::editor::SyncMapBrushPreview(), yaze::editor::internal::SyncSheetPreview(), yaze::gfx::AtlasRenderer::UpdateBitmap(), yaze::editor::MapRefreshCoordinator::UpdateBlocksetWithPendingTileChanges(), yaze::gfx::UpdateTile16(), and yaze::gfx::UpdateTilemap().

◆ vector()

const std::vector< uint8_t > & yaze::gfx::Bitmap::vector ( ) const

inline

Definition at line 411 of file bitmap.h.

References data_.

Referenced by yaze::gfx::AtlasRenderer::AddBitmap(), yaze::gfx::AtlasRenderer::AddBitmapWithBppOptimization(), ApplyPaletteByMetadata(), ApplyStoredPalette(), yaze::gui::Canvas::ConvertBitmapFormat(), CopySurfaceState(), yaze::editor::Tile16EditSession::CopyTile16ToClipboard(), Create(), DetachSurfaceForArena(), yaze::editor::PixelEditorPanel::DisplaySheet(), yaze::editor::SpriteEditor::DrawSpriteCanvas(), yaze::editor::Tile16EditSession::DrawToCurrentTile16Impl(), FindColorIndex(), yaze::gui::BppComparisonTool::GenerateComparisons(), Get16x16Tile(), Get8x8Tile(), yaze::gui::Canvas::GetCurrentBppFormat(), GetPixel(), yaze::gfx::GetTilemapData(), HashColor(), InvalidatePaletteCache(), yaze::editor::Tile16EditSession::PasteTile16FromClipboardImpl(), yaze::editor::GfxGroupEditor::PrepareSheetPreview(), yaze::editor::Tile16EditSession::PreviewPaletteChange(), ReadColor(), Reformat(), yaze::gui::BppFormatUI::RenderAnalysisPanel(), yaze::zelda3::TitleScreen::RenderBG1Layer(), yaze::zelda3::TitleScreen::RenderBG2Layer(), yaze::editor::sprite_graphics_context::RenderCapturedFrame(), yaze::zelda3::TitleScreen::RenderCompositeLayer(), yaze::gui::BppFormatUI::RenderConversionPreview(), yaze::gui::BppFormatUI::RenderFormatSelector(), yaze::editor::usage_preview::SpriteUsagePreview::RenderFrame(), yaze::zelda3::OverworldMapScreen::RenderMapLayer(), yaze::gfx::RenderTile(), yaze::gfx::RenderTile16(), Resize(), yaze::editor::Tile16EditSession::SaveTile16ToScratchSpace(), set_data(), SetPalette(), SetPaletteWithTransparent(), SetPixel(), yaze::gui::PaletteEditorWidget::ShowColorAnalysis(), yaze::editor::usage_preview::SnapshotBitmap(), yaze::editor::SyncMapBrushPreview(), yaze::editor::internal::SyncSheetPreview(), yaze::editor::MapRefreshCoordinator::UpdateBlocksetWithPendingTileChanges(), yaze::editor::Tile16EditSession::UpdateLivePreview(), yaze::gui::BppConversionDialog::UpdatePreview(), UpdateSurfacePixels(), ValidateDataSurfaceSync(), WriteColor(), WriteToPixel(), and WriteToPixel().

◆ at()

uint8_t yaze::gfx::Bitmap::at ( int i ) const

inline

Definition at line 412 of file bitmap.h.

References data_.

Referenced by yaze::editor::OverworldEditor::map_bitmap(), and yaze::editor::TilePaintingManager::map_brush_preview().

◆ modified()

bool yaze::gfx::Bitmap::modified ( ) const

inline

Definition at line 413 of file bitmap.h.

References modified_.

Referenced by yaze::editor::Tile16EditSession::CommitChangesToBlockset(), yaze::gfx::EnsureCompositeBitmapTextureQueued(), set_modified(), and yaze::zelda3::anonymous_namespace{object_drawer.cc}::SyncModifiedBitmapToSurface().

◆ is_active()

bool yaze::gfx::Bitmap::is_active ( ) const

inline

Definition at line 414 of file bitmap.h.

References active_.

◆ generation()

uint32_t yaze::gfx::Bitmap::generation ( ) const

inline

Definition at line 415 of file bitmap.h.

References generation_.

Referenced by yaze::gfx::Arena::HasPendingTextureCommand(), and yaze::gfx::Arena::QueueTextureCommand().

◆ set_active()

void yaze::gfx::Bitmap::set_active ( bool active )

inline

Definition at line 416 of file bitmap.h.

References active_.

Referenced by yaze::zelda3::OverworldMapScreen::Create(), yaze::gfx::EnsureCompositeBitmapTextureQueued(), yaze::editor::internal::EnsureSheetTextureQueued(), and yaze::zelda3::TitleScreen::LoadTitleScreen().

◆ set_data()

void yaze::gfx::Bitmap::set_data ( const std::vector< uint8_t > & data )

Definition at line 901 of file bitmap.cc.

References data(), data_, modified_, pixel_data_, UpdateSurfacePixels(), and vector().

Referenced by yaze::gui::Canvas::ConvertBitmapFormat(), yaze::editor::PixelEditorPanel::DisplaySheet(), yaze::editor::ScreenEditor::DrawDungeonMapScreen(), yaze::editor::UsagePreviewView::ShowImage(), yaze::editor::anonymous_namespace{map_refresh_coordinator.cc}::SyncCurrentGraphicsBitmapForTile16Editor(), yaze::gfx::UpdateTile16(), and yaze::gfx::UpdateTilemap().

Here is the call graph for this function:

◆ set_modified()

void yaze::gfx::Bitmap::set_modified ( bool modified )

inline

Definition at line 418 of file bitmap.h.

References modified(), and modified_.

Referenced by yaze::gui::CanvasUtils::ApplyPaletteGroup(), yaze::editor::Tile16EditSession::ApplyPaletteToCurrentTile16Bitmap(), yaze::editor::OverworldEditor::ClearScratchSpace(), yaze::zelda3::RoomLayerManager::CompositeToOutput(), yaze::editor::Tile16EditSession::CopyTile16ToAtlas(), yaze::editor::Tile16EditSession::CopyTileBitmapToBlockset(), yaze::zelda3::ObjectDrawer::DrawTileToBitmap(), yaze::editor::Tile16EditSession::DrawToCurrentTile16Impl(), yaze::gfx::EnsureCompositeBitmapTextureQueued(), yaze::editor::Tile16EditSession::RefreshAllPalettes(), yaze::editor::Tile16EditSession::RefreshTile16Blockset(), yaze::editor::MapRefreshCoordinator::UpdateBlocksetWithPendingTileChanges(), yaze::editor::OverworldEditor::UpdateScratchBitmapTile(), and yaze::editor::Tile16EditSession::UpdateTile8Palette().

Here is the call graph for this function:

◆ set_texture()

void yaze::gfx::Bitmap::set_texture ( TextureHandle texture )

inline

Definition at line 419 of file bitmap.h.

References texture(), and texture_.

Here is the call graph for this function:

◆ CopySurfaceState()

void yaze::gfx::Bitmap::CopySurfaceState ( const Bitmap & other )

private

Definition at line 391 of file bitmap.cc.

References yaze::platform::GetSurfacePalette(), palette(), SetPalette(), surface_, and vector().

Referenced by Bitmap(), and operator=().

Here is the call graph for this function:

◆ DetachSurfaceForArena()

SDL_Surface * yaze::gfx::Bitmap::DetachSurfaceForArena ( )

inlineprivatenoexcept

Definition at line 428 of file bitmap.h.

References surface(), surface_, and vector().

Referenced by yaze::gfx::Arena::RetireBitmap().

Here is the call graph for this function:

◆ DetachTextureForArena()

TextureHandle yaze::gfx::Bitmap::DetachTextureForArena ( )

inlineprivatenoexcept

Definition at line 433 of file bitmap.h.

References texture(), and texture_.

Referenced by yaze::gfx::Arena::RetireBitmap().

Here is the call graph for this function:

◆ MarkRetiredByArena()

void yaze::gfx::Bitmap::MarkRetiredByArena ( )

inlineprivatenoexcept

Definition at line 438 of file bitmap.h.

References active_, generation_, modified_, next_generation_, and texture_pixels.

Referenced by yaze::gfx::Arena::RetireBitmap().

◆ HashColor()

uint32_t yaze::gfx::Bitmap::HashColor ( const ImVec4 & color )

staticprivate

Hash a color for cache lookup.

Parameters

color ImVec4 color to hash

Returns: 32-bit hash value

Parameters

color ImVec4 color to hash

Returns: 32-bit hash value

Performance Notes:

Simple hash combining RGBA components
Fast integer operations for cache key generation
Collision-resistant for typical SNES palette sizes

Definition at line 852 of file bitmap.cc.

References vector().

Referenced by FindColorIndex(), and InvalidatePaletteCache().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ Arena

friend class Arena

friend

Definition at line 422 of file bitmap.h.

Member Data Documentation

◆ width_

int yaze::gfx::Bitmap::width_ = 0

private

Definition at line 444 of file bitmap.h.

Referenced by Bitmap(), Create(), Get16x16Tile(), Get8x8Tile(), GetPixel(), operator=(), ReadColor(), Reformat(), Resize(), SetPixel(), ToRgba(), UpdateSurfacePixels(), ValidateDataSurfaceSync(), width(), WriteToPixel(), and WriteToPixel().

◆ height_

int yaze::gfx::Bitmap::height_ = 0

private

Definition at line 445 of file bitmap.h.

Referenced by Bitmap(), Create(), Get8x8Tile(), GetPixel(), height(), operator=(), ReadColor(), Reformat(), Resize(), SetPixel(), ToRgba(), UpdateSurfacePixels(), ValidateDataSurfaceSync(), and WriteToPixel().

◆ depth_

int yaze::gfx::Bitmap::depth_ = 0

private

Definition at line 446 of file bitmap.h.

Referenced by Bitmap(), Create(), depth(), IsIndexed(), operator=(), Reformat(), and Resize().

◆ active_

bool yaze::gfx::Bitmap::active_ = false

private

Definition at line 448 of file bitmap.h.

Referenced by Bitmap(), Create(), is_active(), MarkRetiredByArena(), operator=(), Reformat(), Resize(), set_active(), and WriteToPixel().

◆ modified_

bool yaze::gfx::Bitmap::modified_ = false

private

Definition at line 449 of file bitmap.h.

Referenced by Fill(), MarkRetiredByArena(), modified(), operator=(), Resize(), set_data(), set_modified(), SetPalette(), SetPalette(), SetPixel(), and WriteToPixel().

◆ generation_

uint32_t yaze::gfx::Bitmap::generation_ = 0

private

Definition at line 453 of file bitmap.h.

Referenced by Create(), generation(), MarkRetiredByArena(), and operator=().

◆ next_generation_

uint32_t yaze::gfx::Bitmap::next_generation_ = 1

inlinestaticprivate

Definition at line 454 of file bitmap.h.

Referenced by Create(), MarkRetiredByArena(), and operator=().

◆ texture_pixels

void* yaze::gfx::Bitmap::texture_pixels = nullptr

private

Definition at line 457 of file bitmap.h.

Referenced by MarkRetiredByArena().

◆ pixel_data_

uint8_t* yaze::gfx::Bitmap::pixel_data_ = nullptr

private

Definition at line 460 of file bitmap.h.

Referenced by Bitmap(), Create(), operator=(), Reformat(), Resize(), set_data(), SetPixel(), and WriteToPixel().

◆ palette_

gfx::SnesPalette yaze::gfx::Bitmap::palette_

private

Internal SNES palette storage (may be empty!)

This stores the palette in SNES 15-bit RGB format for serialization and palette editing. It is populated by SetPalette(SnesPalette) but NOT by SetPalette(vector<SDL_Color>).

Warning: This may be EMPTY for bitmaps that had their palette set via SetPalette(vector<SDL_Color>). To reliably get the active palette, extract it from the SDL surface: surface_->format->palette->colors

See also: SetPalette(const SnesPalette&) - populates this member; SetPalette(const std::vector<SDL_Color>&) - does NOT populate this

Definition at line 476 of file bitmap.h.

Referenced by ApplyStoredPalette(), Create(), InvalidatePaletteCache(), mutable_palette(), operator=(), palette(), Reformat(), SetPalette(), and SetPaletteWithTransparent().

◆ metadata_

BitmapMetadata yaze::gfx::Bitmap::metadata_

private

Definition at line 479 of file bitmap.h.

Referenced by ApplyPaletteByMetadata(), metadata(), metadata(), and operator=().

◆ data_

std::vector<uint8_t> yaze::gfx::Bitmap::data_

private

Definition at line 482 of file bitmap.h.

Referenced by at(), Bitmap(), Create(), Create(), data(), Fill(), Get16x16Tile(), Get8x8Tile(), GetPixel(), mutable_data(), operator=(), ReadColor(), Reformat(), Resize(), set_data(), SetPixel(), size(), UpdateSurfacePixels(), ValidateDataSurfaceSync(), vector(), and WriteToPixel().

◆ surface_

SDL_Surface* yaze::gfx::Bitmap::surface_ = nullptr

private

SDL surface for rendering (contains the authoritative palette)

For 8-bit indexed bitmaps, the surface contains:

pixels: Raw indexed pixel data (same as data_ after UpdateSurfacePixels)
format->palette: The SDL_Palette used for rendering to textures

The SDL palette (surface_->format->palette) is the authoritative source for color data when rendering. When SDL converts indexed pixels to RGBA for texture creation, it uses this palette.

Note: To copy a palette between bitmaps:
SDL_Palette* src_pal = src.surface()->format->palette;

std::vector<SDL_Color> colors(src_pal->ncolors);

for (int i = 0; i < src_pal->ncolors; ++i) {

colors[i] = src_pal->colors[i];

}

dst.SetPalette(colors);

See also: RoomLayerManager::CompositeToOutput() for palette extraction example

Definition at line 507 of file bitmap.h.

Referenced by ApplyStoredPalette(), Bitmap(), CopySurfaceState(), Create(), DetachSurfaceForArena(), operator=(), ReadColor(), Reformat(), Resize(), SetPalette(), SetPaletteWithTransparent(), SetPixel(), surface(), UpdateSurfacePixels(), ValidateDataSurfaceSync(), WriteColor(), and WriteToPixel().

◆ texture_

TextureHandle yaze::gfx::Bitmap::texture_ = nullptr

private

Definition at line 510 of file bitmap.h.

Referenced by DetachTextureForArena(), operator=(), set_texture(), and texture().

◆ color_to_index_cache_

std::unordered_map<uint32_t, uint8_t> yaze::gfx::Bitmap::color_to_index_cache_

private

Definition at line 513 of file bitmap.h.

Referenced by FindColorIndex(), and InvalidatePaletteCache().

◆ dirty_region_

struct yaze::gfx::Bitmap::DirtyRegion yaze::gfx::Bitmap::dirty_region_

private

Referenced by SetPixel().

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

src/app/gfx/core/bitmap.h
src/app/gfx/core/bitmap.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ BitmapPurpose

Constructor & Destructor Documentation

◆ Bitmap() [1/5]

◆ Bitmap() [2/5]

◆ Bitmap() [3/5]

◆ Bitmap() [4/5]

◆ Bitmap() [5/5]

◆ ~Bitmap()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ Reformat()

◆ Fill()

◆ CreateTexture()

◆ UpdateTexture()

◆ QueueTextureUpdate()

◆ UpdateTextureData()

◆ SetPalette() [1/2]

◆ SetPaletteWithTransparent()

◆ ApplyPaletteByMetadata()

◆ ApplyStoredPalette()

◆ UpdateSurfacePixels()

◆ SetPalette() [2/2]

◆ WriteToPixel() [1/2]

◆ WriteToPixel() [2/2]

◆ GetPixel()

◆ WriteColor()

◆ SetPixel()

◆ Resize()

◆ InvalidatePaletteCache()

◆ FindColorIndex()

◆ ValidateDataSurfaceSync()

◆ Get8x8Tile()

◆ Get16x16Tile()

◆ palette()

◆ mutable_palette()

◆ metadata() [1/2]

◆ metadata() [2/2]

◆ width()

◆ height()

◆ depth()

◆ IsIndexed()

◆ ReadColor()

◆ ToRgba()

◆ size()

◆ data()

◆ mutable_data()

◆ surface()

◆ texture()

◆ vector()

◆ at()

◆ modified()

◆ is_active()

◆ generation()

◆ set_active()

◆ set_data()

◆ set_modified()

◆ set_texture()

◆ CopySurfaceState()

◆ DetachSurfaceForArena()

◆ DetachTextureForArena()

◆ MarkRetiredByArena()

◆ HashColor()

Friends And Related Symbol Documentation

◆ Arena

Member Data Documentation

◆ width_