Struct LoadBMFontFromStream

Namespace

BSGameLib.Game.Fonts

Assembly

BSGameLib.Game.dll

Loads a BMFont from the text of a .fnt file read from a stream. Its page images are read from PageFolder, or from the working directory when it is null.

public readonly record struct LoadBMFontFromStream : IFontParameters, IEquatable<LoadBMFontFromStream>

Implements

IFontParameters

IEquatable<LoadBMFontFromStream>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

LoadBMFontFromStream(string, Stream, string)

Loads a BMFont from the text of a .fnt file read from a stream. Its page images are read from PageFolder, or from the working directory when it is null.

public LoadBMFontFromStream(string FileName, Stream Stream, string PageFolder = null)

Parameters

FileName string

The name the font is known by, kept as its FileName. It need not be a path.

Stream Stream

The stream the .fnt text is read from. The factory disposes it.

PageFolder string

The folder the page images are read from, or null to read them relative to the working directory.

Properties

FileName

The name the font is known by, kept as its FileName. It need not be a path.

public string FileName { get; init; }

Property Value

string

PageFolder

The folder the page images are read from, or null to read them relative to the working directory.

public string PageFolder { get; init; }

Property Value

string

Stream

The stream the .fnt text is read from. The factory disposes it.

public Stream Stream { get; init; }

Property Value

Stream