Gorgon
Show / Hide Table of Contents

Class SpriteExtractionData

Data used to extract sprites from a texture using a grid.

Inheritance
object
SpriteExtractionData
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Gorgon.Editor.Services
Assembly: Gorgon.Editor.API.dll
Syntax
public class SpriteExtractionData
Remarks

Developers can use this to extract sprite information using a fixed size grid to retrieve texture coordinates from a texture passed to the service.

Properties

| Edit this page View Source

ArrayCount

Property to set or return the number of array indices used.

Declaration
public int ArrayCount { get; set; }
Property Value
Type Description
int
See Also
ISpriteExtractorService
| Edit this page View Source

CellSize

Property to set or return the size of a grid cell.

Declaration
public Size2 CellSize { get; set; }
Property Value
Type Description
Size2
See Also
ISpriteExtractorService
| Edit this page View Source

GridOffset

Property to set or return the offset of the grid, in pixels.

Declaration
public Point GridOffset { get; set; }
Property Value
Type Description
Point
See Also
ISpriteExtractorService
| Edit this page View Source

GridSize

Property to set or return the number of columns/rows in the grid.

Declaration
public Size2 GridSize { get; set; }
Property Value
Type Description
Size2
See Also
ISpriteExtractorService
| Edit this page View Source

MaxGridSize

Property to return the maximum columns and rows allowed in the grid.

Declaration
public Size2 MaxGridSize { get; }
Property Value
Type Description
Size2
See Also
ISpriteExtractorService
| Edit this page View Source

SkipColor

Property to set or return the color to use when skipping empty sprites.

Declaration
public GorgonColor SkipColor { get; set; }
Property Value
Type Description
GorgonColor
See Also
ISpriteExtractorService
| Edit this page View Source

SkipEmpty

Property to set or return whether to skip empty sprites.

Declaration
public bool SkipEmpty { get; set; }
Property Value
Type Description
bool
See Also
ISpriteExtractorService
| Edit this page View Source

SpriteCount

Property to return the number of sprites that will be extracted.

Declaration
public int SpriteCount { get; }
Property Value
Type Description
int
See Also
ISpriteExtractorService
| Edit this page View Source

StartArrayIndex

Property to set or return the starting array index to use.

Declaration
public int StartArrayIndex { get; set; }
Property Value
Type Description
int
See Also
ISpriteExtractorService
| Edit this page View Source

Texture

Property to set or return the texture that is to be rendered.

Declaration
public GorgonTexture2DView Texture { get; set; }
Property Value
Type Description
GorgonTexture2DView
See Also
ISpriteExtractorService

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)
GorgonNullExtensions.AsNullable<T>(object)
GorgonNullExtensions.IfNull<T>(object, T)
GorgonNullExtensions.IsNull(object)

See Also

ISpriteExtractorService
  • Edit this page
  • View Source
In this article
Back to top Copyright 2023 - Licensed under the MIT license by Michael Winsor (Tape_Worm).
Send comments on this topic to the author