Skip to content

Commit

Permalink
📚 Documentation update for 0.1.0-preview.185
Browse files Browse the repository at this point in the history
  • Loading branch information
PleOps.Cake Bot committed Sep 20, 2023
1 parent cc7d45b commit 640b4cb
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion api/Texim.Sprites.FullImage2SpriteParams.html
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Texim.Pixels.IndexedPixel.html">IndexedPixel</a>&gt;</td>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Texim.Pixels.IndexedPixel.html">IndexedPixel</a>&gt;</td>
<td></td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion api/Texim.Sprites.SpriteImageUpdaterParams.html
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Texim.Pixels.IndexedPixel.html">IndexedPixel</a>&gt;</td>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Texim.Pixels.IndexedPixel.html">IndexedPixel</a>&gt;</td>
<td></td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions index.json
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@
"api/Texim.Sprites.FullImage2SpriteParams.html": {
"href": "api/Texim.Sprites.FullImage2SpriteParams.html",
"title": "Class FullImage2SpriteParams | Texim extensible image API",
"keywords": "Class FullImage2SpriteParams Inheritance Object FullImage2SpriteParams Implements IEquatable < FullImage2SpriteParams > Namespace : Texim.Sprites Assembly : Texim.dll Syntax public class FullImage2SpriteParams : Object Constructors FullImage2SpriteParams() Declaration public FullImage2SpriteParams() FullImage2SpriteParams(FullImage2SpriteParams) Declaration protected FullImage2SpriteParams(FullImage2SpriteParams original) Parameters Type Name Description FullImage2SpriteParams original Properties EqualityContract Declaration protected virtual Type EqualityContract { get; } Property Value Type Description Type IsImageTiled Gets a value indicating whether the image pixels are tiled or not. Declaration public bool IsImageTiled { get; set; } Property Value Type Description Boolean MinimumPixelsPerSegment Gets the minimum amount of pixels a sprite segment should have. Usually this is the same as PixelsPerIndex , except in NCER formats where it multiplies by a block size parameter. Declaration public int MinimumPixelsPerSegment { get; set; } Property Value Type Description Int32 Palettes Gets the collection of palettes the converter will use to quantize the image. It will not modify or append any new color or palette. Declaration public IPaletteCollection Palettes { get; set; } Property Value Type Description IPaletteCollection PixelSequences Gets the sequence of tiles the converter will use to search and add new pixels if not found. Declaration public List<IndexedPixel> PixelSequences { get; set; } Property Value Type Description List < IndexedPixel > PixelsPerIndex Gets the amount of pixels each segment tile index increments. Usually this is the tile size (64). Declaration public int PixelsPerIndex { get; set; } Property Value Type Description Int32 RelativeCoordinates Gets the type of relative coordinates of the segments. It must match with the value used in RelativeCoordinates when exporting. Declaration public SpriteRelativeCoordinatesKind RelativeCoordinates { get; set; } Property Value Type Description SpriteRelativeCoordinatesKind Segmentation Gets the algorithm to segment the image. By default, the one that works for Nintendo DS. Declaration public IImageSegmentation Segmentation { get; set; } Property Value Type Description IImageSegmentation SupportsFlipping Gets a value indicating whether this sprite supports horizontal and vertical flipping. Declaration public bool SupportsFlipping { get; set; } Property Value Type Description Boolean Remarks Some games may not support this feature of the segments. Methods <Clone>$() Declaration public virtual FullImage2SpriteParams <Clone>$() Returns Type Description FullImage2SpriteParams Equals(Object) Declaration public override bool Equals(object obj) Parameters Type Name Description Object obj Returns Type Description Boolean Equals(FullImage2SpriteParams) Declaration public virtual bool Equals(FullImage2SpriteParams other) Parameters Type Name Description FullImage2SpriteParams other Returns Type Description Boolean GetHashCode() Declaration public override int GetHashCode() Returns Type Description Int32 PrintMembers(StringBuilder) Declaration protected virtual bool PrintMembers(StringBuilder builder) Parameters Type Name Description StringBuilder builder Returns Type Description Boolean ToString() Declaration public override string ToString() Returns Type Description String Operators Equality(FullImage2SpriteParams, FullImage2SpriteParams) Declaration public static bool operator ==(FullImage2SpriteParams left, FullImage2SpriteParams right) Parameters Type Name Description FullImage2SpriteParams left FullImage2SpriteParams right Returns Type Description Boolean Inequality(FullImage2SpriteParams, FullImage2SpriteParams) Declaration public static bool operator !=(FullImage2SpriteParams left, FullImage2SpriteParams right) Parameters Type Name Description FullImage2SpriteParams left FullImage2SpriteParams right Returns Type Description Boolean Implements System.IEquatable<T>"
"keywords": "Class FullImage2SpriteParams Inheritance Object FullImage2SpriteParams Implements IEquatable < FullImage2SpriteParams > Namespace : Texim.Sprites Assembly : Texim.dll Syntax public class FullImage2SpriteParams : Object Constructors FullImage2SpriteParams() Declaration public FullImage2SpriteParams() FullImage2SpriteParams(FullImage2SpriteParams) Declaration protected FullImage2SpriteParams(FullImage2SpriteParams original) Parameters Type Name Description FullImage2SpriteParams original Properties EqualityContract Declaration protected virtual Type EqualityContract { get; } Property Value Type Description Type IsImageTiled Gets a value indicating whether the image pixels are tiled or not. Declaration public bool IsImageTiled { get; set; } Property Value Type Description Boolean MinimumPixelsPerSegment Gets the minimum amount of pixels a sprite segment should have. Usually this is the same as PixelsPerIndex , except in NCER formats where it multiplies by a block size parameter. Declaration public int MinimumPixelsPerSegment { get; set; } Property Value Type Description Int32 Palettes Gets the collection of palettes the converter will use to quantize the image. It will not modify or append any new color or palette. Declaration public IPaletteCollection Palettes { get; set; } Property Value Type Description IPaletteCollection PixelSequences Gets the sequence of tiles the converter will use to search and add new pixels if not found. Declaration public List<IndexedPixel> PixelSequences { get; set; } Property Value Type Description System.Collections.Generic.List < IndexedPixel > PixelsPerIndex Gets the amount of pixels each segment tile index increments. Usually this is the tile size (64). Declaration public int PixelsPerIndex { get; set; } Property Value Type Description Int32 RelativeCoordinates Gets the type of relative coordinates of the segments. It must match with the value used in RelativeCoordinates when exporting. Declaration public SpriteRelativeCoordinatesKind RelativeCoordinates { get; set; } Property Value Type Description SpriteRelativeCoordinatesKind Segmentation Gets the algorithm to segment the image. By default, the one that works for Nintendo DS. Declaration public IImageSegmentation Segmentation { get; set; } Property Value Type Description IImageSegmentation SupportsFlipping Gets a value indicating whether this sprite supports horizontal and vertical flipping. Declaration public bool SupportsFlipping { get; set; } Property Value Type Description Boolean Remarks Some games may not support this feature of the segments. Methods <Clone>$() Declaration public virtual FullImage2SpriteParams <Clone>$() Returns Type Description FullImage2SpriteParams Equals(Object) Declaration public override bool Equals(object obj) Parameters Type Name Description Object obj Returns Type Description Boolean Equals(FullImage2SpriteParams) Declaration public virtual bool Equals(FullImage2SpriteParams other) Parameters Type Name Description FullImage2SpriteParams other Returns Type Description Boolean GetHashCode() Declaration public override int GetHashCode() Returns Type Description Int32 PrintMembers(StringBuilder) Declaration protected virtual bool PrintMembers(StringBuilder builder) Parameters Type Name Description StringBuilder builder Returns Type Description Boolean ToString() Declaration public override string ToString() Returns Type Description String Operators Equality(FullImage2SpriteParams, FullImage2SpriteParams) Declaration public static bool operator ==(FullImage2SpriteParams left, FullImage2SpriteParams right) Parameters Type Name Description FullImage2SpriteParams left FullImage2SpriteParams right Returns Type Description Boolean Inequality(FullImage2SpriteParams, FullImage2SpriteParams) Declaration public static bool operator !=(FullImage2SpriteParams left, FullImage2SpriteParams right) Parameters Type Name Description FullImage2SpriteParams left FullImage2SpriteParams right Returns Type Description Boolean Implements System.IEquatable<T>"
},
"api/Texim.Sprites.html": {
"href": "api/Texim.Sprites.html",
Expand Down Expand Up @@ -487,7 +487,7 @@
"api/Texim.Sprites.SpriteImageUpdaterParams.html": {
"href": "api/Texim.Sprites.SpriteImageUpdaterParams.html",
"title": "Class SpriteImageUpdaterParams | Texim extensible image API",
"keywords": "Class SpriteImageUpdaterParams Inheritance Object SpriteImageUpdaterParams Implements IEquatable < SpriteImageUpdaterParams > Namespace : Texim.Sprites Assembly : Texim.dll Syntax public class SpriteImageUpdaterParams : Object Constructors SpriteImageUpdaterParams() Declaration public SpriteImageUpdaterParams() SpriteImageUpdaterParams(SpriteImageUpdaterParams) Declaration protected SpriteImageUpdaterParams(SpriteImageUpdaterParams original) Parameters Type Name Description SpriteImageUpdaterParams original Properties EqualityContract Declaration protected virtual Type EqualityContract { get; } Property Value Type Description Type Image Gets the image to update in the sprite. Declaration public IIndexedImage Image { get; set; } Property Value Type Description IIndexedImage MinimumPixelsPerSegment Gets the minimum amount of pixels a sprite segment should have. Usually this is the same as PixelsPerIndex , except in NCER formats where it multiplies by a block size parameter. Declaration public int MinimumPixelsPerSegment { get; set; } Property Value Type Description Int32 PixelSequences Gets the sequence of tiles the converter will use to search and add new pixels if not found. Declaration public List<IndexedPixel> PixelSequences { get; set; } Property Value Type Description List < IndexedPixel > PixelsPerIndex Gets the amount of pixels each segment tile index increments. Usually this is the tile size (64). Declaration public int PixelsPerIndex { get; set; } Property Value Type Description Int32 SupportsFlipping Gets a value indicating whether this sprite supports horizontal and vertical flipping. Declaration public bool SupportsFlipping { get; set; } Property Value Type Description Boolean Remarks Some games may not support this feature of the segments. Methods <Clone>$() Declaration public virtual SpriteImageUpdaterParams <Clone>$() Returns Type Description SpriteImageUpdaterParams Equals(Object) Declaration public override bool Equals(object obj) Parameters Type Name Description Object obj Returns Type Description Boolean Equals(SpriteImageUpdaterParams) Declaration public virtual bool Equals(SpriteImageUpdaterParams other) Parameters Type Name Description SpriteImageUpdaterParams other Returns Type Description Boolean GetHashCode() Declaration public override int GetHashCode() Returns Type Description Int32 PrintMembers(StringBuilder) Declaration protected virtual bool PrintMembers(StringBuilder builder) Parameters Type Name Description StringBuilder builder Returns Type Description Boolean ToString() Declaration public override string ToString() Returns Type Description String Operators Equality(SpriteImageUpdaterParams, SpriteImageUpdaterParams) Declaration public static bool operator ==(SpriteImageUpdaterParams left, SpriteImageUpdaterParams right) Parameters Type Name Description SpriteImageUpdaterParams left SpriteImageUpdaterParams right Returns Type Description Boolean Inequality(SpriteImageUpdaterParams, SpriteImageUpdaterParams) Declaration public static bool operator !=(SpriteImageUpdaterParams left, SpriteImageUpdaterParams right) Parameters Type Name Description SpriteImageUpdaterParams left SpriteImageUpdaterParams right Returns Type Description Boolean Implements System.IEquatable<T>"
"keywords": "Class SpriteImageUpdaterParams Inheritance Object SpriteImageUpdaterParams Implements IEquatable < SpriteImageUpdaterParams > Namespace : Texim.Sprites Assembly : Texim.dll Syntax public class SpriteImageUpdaterParams : Object Constructors SpriteImageUpdaterParams() Declaration public SpriteImageUpdaterParams() SpriteImageUpdaterParams(SpriteImageUpdaterParams) Declaration protected SpriteImageUpdaterParams(SpriteImageUpdaterParams original) Parameters Type Name Description SpriteImageUpdaterParams original Properties EqualityContract Declaration protected virtual Type EqualityContract { get; } Property Value Type Description Type Image Gets the image to update in the sprite. Declaration public IIndexedImage Image { get; set; } Property Value Type Description IIndexedImage MinimumPixelsPerSegment Gets the minimum amount of pixels a sprite segment should have. Usually this is the same as PixelsPerIndex , except in NCER formats where it multiplies by a block size parameter. Declaration public int MinimumPixelsPerSegment { get; set; } Property Value Type Description Int32 PixelSequences Gets the sequence of tiles the converter will use to search and add new pixels if not found. Declaration public List<IndexedPixel> PixelSequences { get; set; } Property Value Type Description System.Collections.Generic.List < IndexedPixel > PixelsPerIndex Gets the amount of pixels each segment tile index increments. Usually this is the tile size (64). Declaration public int PixelsPerIndex { get; set; } Property Value Type Description Int32 SupportsFlipping Gets a value indicating whether this sprite supports horizontal and vertical flipping. Declaration public bool SupportsFlipping { get; set; } Property Value Type Description Boolean Remarks Some games may not support this feature of the segments. Methods <Clone>$() Declaration public virtual SpriteImageUpdaterParams <Clone>$() Returns Type Description SpriteImageUpdaterParams Equals(Object) Declaration public override bool Equals(object obj) Parameters Type Name Description Object obj Returns Type Description Boolean Equals(SpriteImageUpdaterParams) Declaration public virtual bool Equals(SpriteImageUpdaterParams other) Parameters Type Name Description SpriteImageUpdaterParams other Returns Type Description Boolean GetHashCode() Declaration public override int GetHashCode() Returns Type Description Int32 PrintMembers(StringBuilder) Declaration protected virtual bool PrintMembers(StringBuilder builder) Parameters Type Name Description StringBuilder builder Returns Type Description Boolean ToString() Declaration public override string ToString() Returns Type Description String Operators Equality(SpriteImageUpdaterParams, SpriteImageUpdaterParams) Declaration public static bool operator ==(SpriteImageUpdaterParams left, SpriteImageUpdaterParams right) Parameters Type Name Description SpriteImageUpdaterParams left SpriteImageUpdaterParams right Returns Type Description Boolean Inequality(SpriteImageUpdaterParams, SpriteImageUpdaterParams) Declaration public static bool operator !=(SpriteImageUpdaterParams left, SpriteImageUpdaterParams right) Parameters Type Name Description SpriteImageUpdaterParams left SpriteImageUpdaterParams right Returns Type Description Boolean Implements System.IEquatable<T>"
},
"api/Texim.Sprites.SpriteRelativeCoordinatesKind.html": {
"href": "api/Texim.Sprites.SpriteRelativeCoordinatesKind.html",
Expand Down
4 changes: 2 additions & 2 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1038,7 +1038,7 @@
"output": {
".html": {
"relative_path": "api/Texim.Sprites.FullImage2SpriteParams.html",
"hash": "JwoW68mG+TapzOwZMs9eRdTJPHedDQECDfNO2ZKv5lU="
"hash": "n7U3cvDiqUchjndkCu4dEg7Y5DP97+raTPXJqJLfd6o="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -1194,7 +1194,7 @@
"output": {
".html": {
"relative_path": "api/Texim.Sprites.SpriteImageUpdaterParams.html",
"hash": "GUxbfCQBG60M8oQJUK3/4VLGfQ+p1TSaOW+5W8fK5CU="
"hash": "GC7Tl/C26lA4D34QoDEImufSPFGgljKv6riD4KGlGbw="
}
},
"is_incremental": false,
Expand Down

0 comments on commit 640b4cb

Please sign in to comment.