Class GorgonV2SpriteCodec

A codec that can read version 2 sprite data.

Inheritance
object
GorgonSpriteCodecCommon
GorgonV2SpriteCodec
Implements
Inherited Members
Namespace: Gorgon.IO
Assembly: Gorgon.IO.Gorgon2D.dll
Syntax
public class GorgonV2SpriteCodec : GorgonSpriteCodecCommon, IGorgonSpriteCodec, IGorgonGraphicsObject, IGorgonNamedObject

Constructors

| Edit this page View Source

GorgonV2SpriteCodec(Gorgon2D)

Initializes a new instance of the GorgonV2SpriteCodec class.

Declaration
public GorgonV2SpriteCodec(Gorgon2D renderer)
Parameters
Type Name Description
Gorgon2D renderer

The renderer used for resource handling.
Exceptions
Type Condition
ArgumentNullException

Thrown when the renderer parameter is null.

Fields

| Edit this page View Source

FileHeader

Header for the Gorgon sprite file.

Declaration
public const string FileHeader = "GORSPR20"
Field Value
Type Description
string

Properties

| Edit this page View Source

CanDecode

Property to return whether or not the codec can decode sprite data.

Declaration
public override bool CanDecode { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

CanEncode

Property to return whether or not the codec can encode sprite data.

Declaration
public override bool CanEncode { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Version

Property to return the version of sprite data that the codec supports.

Declaration
public override Version Version { get; }
Property Value
Type Description
Version
Overrides

Methods

| Edit this page View Source

OnGetAssociatedTextureName(Stream)

Function to retrieve the name of the associated texture.

Declaration
protected override string OnGetAssociatedTextureName(Stream stream)
Parameters
Type Name Description
Stream stream

The stream containing the texture data.
Returns
Type Description
string

The name of the texture associated with the sprite, or null if no texture was found.
Overrides
| Edit this page View Source

OnIsReadable(Stream)

Function to determine if the data in a stream is readable by this codec.

Declaration
protected override bool OnIsReadable(Stream stream)
Parameters
Type Name Description
Stream stream

The stream containing the data.
Returns
Type Description
bool

true if the data can be read, or false if not.
Overrides
| Edit this page View Source

OnReadFromStream(Stream, int, GorgonTexture2DView)

Function to read the sprite data from a stream.

Declaration
protected override GorgonSprite OnReadFromStream(Stream stream, int byteCount, GorgonTexture2DView overrideTexture)
Parameters
Type Name Description
Stream stream

The stream containing the sprite.
int byteCount

The number of bytes to read from the stream.
GorgonTexture2DView overrideTexture

The texture to assign to the sprite instead of the texture associated with the name stored in the file.
Returns
Type Description
GorgonSprite

A new GorgonSprite.
Overrides
| Edit this page View Source

OnSaveToStream(GorgonSprite, Stream)

Function to save the sprite data to a stream.

Declaration
protected override void OnSaveToStream(GorgonSprite sprite, Stream stream)
Parameters
Type Name Description
GorgonSprite sprite

The sprite to serialize into the stream.
Stream stream

The stream that will contain the sprite.
Overrides

Implements

Extension Methods