Gondwana Game Engine
Gondwana is a cross-platform 2.5D game and rendering engine written in C#/.NET 8. It provides fine-grained control over rendering, timing, and scene composition, with built-in support for parallax, z-ordering, pixel overhang, collision detection, and particle effects. Gondwana targets desktop, mobile, and web platforms using SkiaSharp for graphics and NAudio for sound.
Loading...
Searching...
No Matches
Gondwana.Drawing.Frame Struct Reference

Represents the source Tilesheet and its coordinates to render on a destination. More...

Public Member Functions

 Frame (Tilesheet tilesheet, int xTile, int yTile)
 Initializes a new instance of the Frame struct with the specified tilesheet and tile coordinates.

Public Attributes

readonly Tilesheet Tilesheet
 The tilesheet that contains the source bitmap for this frame.
readonly int XTile
 The horizontal tile coordinate (column index) within the tilesheet.
readonly int YTile
 The vertical tile coordinate (row index) within the tilesheet.

Properties

readonly? SKBitmap SkBitmap [get]
 Gets the SkiaSharp bitmap for this frame at the specified tile coordinates. Returns null if the tilesheet is not available.
readonly? SKImage SkImage [get]
 Gets the SkiaSharp image for this frame at the specified tile coordinates. Returns null if the tilesheet is not available.
Size BaseTileSize [get]
 Gets the base tile size (without overhang) from the tilesheet. Returns Size.Empty if the tilesheet is not available.
Overhang OverhangPixels [get]
 Gets the overhang dimensions (in pixels) that extend beyond the base tile boundaries. Returns Overhang.None if the tilesheet is not available.
Size TileSizeWithOverhang [get]
 Gets the total tile size including overhang pixels in all directions. This is calculated as the base tile size plus the left, right, top, and bottom overhang values.

Detailed Description

Represents the source Tilesheet and its coordinates to render on a destination.

Constructor & Destructor Documentation

◆ Frame()

Gondwana.Drawing.Frame.Frame ( Tilesheet tilesheet,
int xTile,
int yTile )

Initializes a new instance of the Frame struct with the specified tilesheet and tile coordinates.

Parameters
tilesheetThe tilesheet containing the source bitmap.
xTileThe horizontal tile coordinate (column index) within the tilesheet.
yTileThe vertical tile coordinate (row index) within the tilesheet.

Member Data Documentation

◆ Tilesheet

readonly Tilesheet Gondwana.Drawing.Frame.Tilesheet

The tilesheet that contains the source bitmap for this frame.

◆ XTile

readonly int Gondwana.Drawing.Frame.XTile

The horizontal tile coordinate (column index) within the tilesheet.

◆ YTile

readonly int Gondwana.Drawing.Frame.YTile

The vertical tile coordinate (row index) within the tilesheet.

Property Documentation

◆ BaseTileSize

Size Gondwana.Drawing.Frame.BaseTileSize
get

Gets the base tile size (without overhang) from the tilesheet. Returns Size.Empty if the tilesheet is not available.

◆ OverhangPixels

Overhang Gondwana.Drawing.Frame.OverhangPixels
get

Gets the overhang dimensions (in pixels) that extend beyond the base tile boundaries. Returns Overhang.None if the tilesheet is not available.

◆ SkBitmap

readonly? SKBitmap Gondwana.Drawing.Frame.SkBitmap
get

Gets the SkiaSharp bitmap for this frame at the specified tile coordinates. Returns null if the tilesheet is not available.

◆ SkImage

readonly? SKImage Gondwana.Drawing.Frame.SkImage
get

Gets the SkiaSharp image for this frame at the specified tile coordinates. Returns null if the tilesheet is not available.

◆ TileSizeWithOverhang

Size Gondwana.Drawing.Frame.TileSizeWithOverhang
get

Gets the total tile size including overhang pixels in all directions. This is calculated as the base tile size plus the left, right, top, and bottom overhang values.