Gondwana Game Engine Development (master) - 2.6.1
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 and web platforms using SkiaSharp for graphics and pluggable audio backends for desktop and browser targets.
Loading...
Searching...
No Matches
Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition Class Referencesealed

Describes an authoring-time source for a logical scene referenced by a GSPR definition. Runtime sprite materialization resolves scene identities against already loaded scenes. More...

Static Public Member Functions

static SpriteSceneSourceDefinition Loose (string sceneId, string gscnPath)
 Creates a reference to a definition stored in a loose file.
static SpriteSceneSourceDefinition Packed (string sceneId, string assetsFilePath, string assetEntryName)
 Creates a reference to a definition stored inside an assets file.

Properties

string SceneId = string.Empty [get, set]
 Gets or sets the identifier of the referenced scene.
SpriteSceneSourceKind Kind = SpriteSceneSourceKind.LooseDefinitionFile [get, set]
 Gets or sets the kind.
string? GscnPath [get, set]
 Gets or sets the path to the loose GSCN scene definition.
string? AssetsFilePath [get, set]
 Gets or sets the path to the containing assets file.
string? AssetEntryName [get, set]
 Gets or sets the entry name inside the assets file.

Detailed Description

Describes an authoring-time source for a logical scene referenced by a GSPR definition. Runtime sprite materialization resolves scene identities against already loaded scenes.

Definition at line 27 of file SpriteSceneSourceDefinition.cs.

Member Function Documentation

◆ Loose()

SpriteSceneSourceDefinition Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.Loose ( string sceneId,
string gscnPath )
static

Creates a reference to a definition stored in a loose file.

Parameters
sceneIdThe scene id.
gscnPathThe path to the loose GSCN scene definition.
Returns
A reference to the loose definition file.

Definition at line 56 of file SpriteSceneSourceDefinition.cs.

◆ Packed()

SpriteSceneSourceDefinition Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.Packed ( string sceneId,
string assetsFilePath,
string assetEntryName )
static

Creates a reference to a definition stored inside an assets file.

Parameters
sceneIdThe scene id.
assetsFilePathThe path to the assets file.
assetEntryNameThe entry name inside the assets file.
Returns
A reference to the packed definition entry.

Definition at line 75 of file SpriteSceneSourceDefinition.cs.

Property Documentation

◆ AssetEntryName

string? Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.AssetEntryName
getset

Gets or sets the entry name inside the assets file.

Definition at line 48 of file SpriteSceneSourceDefinition.cs.

◆ AssetsFilePath

string? Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.AssetsFilePath
getset

Gets or sets the path to the containing assets file.

Definition at line 44 of file SpriteSceneSourceDefinition.cs.

◆ GscnPath

string? Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.GscnPath
getset

Gets or sets the path to the loose GSCN scene definition.

Definition at line 40 of file SpriteSceneSourceDefinition.cs.

◆ Kind

SpriteSceneSourceKind Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.Kind = SpriteSceneSourceKind.LooseDefinitionFile
getset

Gets or sets the kind.

Definition at line 36 of file SpriteSceneSourceDefinition.cs.

◆ SceneId

string Gondwana.Drawing.Sprites.GSPR.SpriteSceneSourceDefinition.SceneId = string.Empty
getset

Gets or sets the identifier of the referenced scene.

Definition at line 32 of file SpriteSceneSourceDefinition.cs.