Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource Class Reference

Captures provenance details for a GSPR scene definition. More...

Static Public Member Functions
static SpriteDefinitionSource	LooseDefinitionFile (string gsprFilePath)
	Creates a source marker for a loose .gspr file.
static SpriteDefinitionSource	PackedDefinitionFile (string assetsFilePath, string assetEntryName)
	Creates a source marker for a packed .gspr entry inside an assets file.
static SpriteDefinitionSource	Generated ()
	Creates a source marker for a definition generated from runtime state or tooling.
static SpriteDefinitionSource	None ()
	Creates an empty source marker when no provenance is known.

Properties
SpriteDefinitionSourceKind	Kind [get]
	Gets the high-level source kind.
string?	GsprFilePath [get]
	Gets the .gspr path when loaded from a loose definition file.
string?	AssetsFilePath [get]
	Gets the .gaf path when loaded from a packed definition file.
string?	AssetEntryName [get]
	Gets the packed entry name when loaded from a packed definition file.

Detailed Description

Captures provenance details for a GSPR scene definition.

Definition at line 8 of file SpriteDefinitionSource.cs.

Member Function Documentation

Generated()

SpriteDefinitionSource Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.Generated ( )

static

Creates a source marker for a definition generated from runtime state or tooling.

Returns

A source descriptor identifying runtime-generated content.

LooseDefinitionFile()

SpriteDefinitionSource Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.LooseDefinitionFile ( string gsprFilePath )

static

Creates a source marker for a loose .gspr file.

Parameters

gsprFilePath

The gspr file path.

Returns

A source descriptor containing the loose definition file path.

Definition at line 42 of file SpriteDefinitionSource.cs.

None()

SpriteDefinitionSource Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.None ( )

static

Creates an empty source marker when no provenance is known.

Returns

A descriptor with no persisted source.

PackedDefinitionFile()

SpriteDefinitionSource Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.PackedDefinitionFile ( string assetsFilePath, string assetEntryName )

static

Creates a source marker for a packed .gspr entry inside an assets file.

Parameters

assetsFilePath	The path to the assets file.
assetEntryName	The entry name inside the assets file.

Returns

A source descriptor containing the assets file path and entry name.

Definition at line 60 of file SpriteDefinitionSource.cs.

Property Documentation

AssetEntryName

string? Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.AssetEntryName

get

Gets the packed entry name when loaded from a packed definition file.

Definition at line 35 of file SpriteDefinitionSource.cs.

AssetsFilePath

string? Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.AssetsFilePath

get

Gets the .gaf path when loaded from a packed definition file.

Definition at line 29 of file SpriteDefinitionSource.cs.

GsprFilePath

string? Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.GsprFilePath

get

Gets the .gspr path when loaded from a loose definition file.

Definition at line 23 of file SpriteDefinitionSource.cs.

Kind

SpriteDefinitionSourceKind Gondwana.Drawing.Sprites.GSPR.SpriteDefinitionSource.Kind

get

Gets the high-level source kind.

Definition at line 17 of file SpriteDefinitionSource.cs.