5806 lines
309 KiB
XML
5806 lines
309 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Syroot.NintenTools.Bfres</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Syroot.NintenTools.Bfres.AnimCurve">
|
|
<summary>
|
|
Represents an animation curve used by several sections to control different parameters over time.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.AnimCurve.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.FrameType">
|
|
<summary>
|
|
Gets or sets the data type in which <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Frames"/> are loaded and saved. For simplicity, the class
|
|
always stores frames as converted <see cref="T:System.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.KeyType">
|
|
<summary>
|
|
Gets or sets the data type in which <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> are loaded and saved. For simplicity, the class
|
|
always stores frames as converted <see cref="T:System.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.CurveType">
|
|
<summary>
|
|
Gets or sets the curve type, determining the number of elements stored with each key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.AnimDataOffset">
|
|
<summary>
|
|
Gets or sets the memory offset relative to the start of the corresponding animation data structure to
|
|
animate the field stored at that address. Note that enums exist in the specific animation which map offsets
|
|
to names.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.StartFrame">
|
|
<summary>
|
|
Gets or sets the first frame at which a key is placed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.EndFrame">
|
|
<summary>
|
|
Gets or sets the last frame at which a key is placed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.Scale">
|
|
<summary>
|
|
Gets or sets the scale to multiply values of the curve by.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.Offset">
|
|
<summary>
|
|
Gets or sets the offset to add to the values of the curve (after multiplicating them).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.Delta">
|
|
<summary>
|
|
Gets or sets the difference between the lowest and highest key value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.Frames">
|
|
<summary>
|
|
Gets the frame numbers at which keys of the same index in the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array are placed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.AnimCurve.Keys">
|
|
<summary>
|
|
Gets an array of elements forming the elements of keys placed at the frames of the same index in the
|
|
<see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Frames"/> array.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.AnimCurveFrameType">
|
|
<summary>
|
|
Represents the possible data types in which <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Frames"/> are stored. For simple library use,
|
|
they are always converted them to and from <see cref="F:Syroot.NintenTools.Bfres.AnimCurveFrameType.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveFrameType.Single">
|
|
<summary>
|
|
The frames are stored as <see cref="T:System.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveFrameType.Decimal10x5">
|
|
<summary>
|
|
The frames are stored as <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveFrameType.Byte">
|
|
<summary>
|
|
The frames are stored as <see cref="T:System.Byte"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.AnimCurveKeyType">
|
|
<summary>
|
|
Represents the possible data types in which <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> are stored. For simple library use,
|
|
they are always converted them to and from <see cref="F:Syroot.NintenTools.Bfres.AnimCurveKeyType.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveKeyType.Single">
|
|
<summary>
|
|
The keys are stored as <see cref="T:System.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveKeyType.Int16">
|
|
<summary>
|
|
The keys are stored as <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveKeyType.SByte">
|
|
<summary>
|
|
The keys are stored as <see cref="T:System.SByte"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.AnimCurveType">
|
|
<summary>
|
|
Represents the type of key values stored by this curve. This also determines the number of required elements to
|
|
define a key in the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array. Use the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.ElementsPerKey"/>
|
|
method to retrieve the number of elements required for the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.CurveType"/> of that curve.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.Cubic">
|
|
<summary>
|
|
The curve uses cubic interpolation. 4 elements of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array form a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.Linear">
|
|
<summary>
|
|
The curve uses linear interpolation. 2 elements of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array form a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.BakedFloat">
|
|
<summary>
|
|
1 element of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array forms a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.StepInt">
|
|
<summary>
|
|
1 element of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array forms a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.BakedInt">
|
|
<summary>
|
|
1 element of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array forms a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.StepBool">
|
|
<summary>
|
|
1 element of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array forms a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimCurveType.BakedBool">
|
|
<summary>
|
|
1 element of the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.Keys"/> array forms a key.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.AnimConstant.AnimDataOffset">
|
|
<summary>
|
|
Gets or sets the memory offset relative to the start of the corresponding animation data structure to
|
|
animate the field stored at that address. Note that enums exist in the specific animation which map offsets
|
|
to names.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Buffer">
|
|
<summary>
|
|
Represents a buffer of data uploaded to the GX2 GPU which can hold arbitrary data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Buffer.Stride">
|
|
<summary>
|
|
The size of a full vertex in bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Buffer.Data">
|
|
<summary>
|
|
The raw bytes stored for each buffering.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Decimal10x5">
|
|
<summary>
|
|
Represents a 16-bit fixed-point decimal consisting of 1 sign bit, 10 integer bits and 5 fractional bits (denoted
|
|
as Q10.5). Note that the implementation is not reporting over- and underflowing errors.
|
|
</summary>
|
|
<remarks>
|
|
Examples:
|
|
SIIIIIII_IIIFFFFF
|
|
0b00000000_00010000 = 0.5
|
|
0b00000000_00100000 = 1
|
|
0b00000001_00000000 = 8
|
|
0b01000000_00000000 = 512
|
|
0b10000000_00000000 = -1024
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Decimal10x5.MaxValue">
|
|
<summary>
|
|
Represents the largest possible value of <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Decimal10x5.MinValue">
|
|
<summary>
|
|
Represents the smallest possible value of <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> struct from the given <paramref name="raw"/>
|
|
representation.
|
|
</summary>
|
|
<param name="raw">The raw representation of the internally stored bits.</param>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Decimal10x5.Raw">
|
|
<summary>
|
|
Gets the internally stored value to represent the instance.
|
|
</summary>
|
|
<remarks>Signed to get arithmetic rather than logical shifts.</remarks>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_UnaryPlus(Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Returns the given <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<param name="a">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>The result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Addition(Syroot.NintenTools.Bfres.Decimal10x5,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Adds the first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>The addition result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_UnaryNegation(Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Negates the given <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<param name="a">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to negate.</param>
|
|
<returns>The negated result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Subtraction(Syroot.NintenTools.Bfres.Decimal10x5,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Subtracts the first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> from the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>The subtraction result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Multiply(Syroot.NintenTools.Bfres.Decimal10x5,System.Int32)">
|
|
<summary>
|
|
Multiplicates the given <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> by the scalar.
|
|
</summary>
|
|
<param name="a">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<param name="s">The scalar.</param>
|
|
<returns>The multiplication result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Multiply(Syroot.NintenTools.Bfres.Decimal10x5,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Multiplicates the first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> by the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>The multiplication result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Division(Syroot.NintenTools.Bfres.Decimal10x5,System.Int32)">
|
|
<summary>
|
|
Divides the given <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> through the scalar.
|
|
</summary>
|
|
<param name="a">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<param name="s">The scalar.</param>
|
|
<returns>The division result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Division(Syroot.NintenTools.Bfres.Decimal10x5,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Divides the first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> through the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>The division result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Equality(Syroot.NintenTools.Bfres.Decimal10x5,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Gets a value indicating whether the first specified <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> is the same as the second
|
|
specified <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to compare.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to compare.</param>
|
|
<returns>true, if both <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> are the same.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Inequality(Syroot.NintenTools.Bfres.Decimal10x5,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Gets a value indicating whether the first specified <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> is not the same as the second
|
|
specified <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to compare.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to compare.</param>
|
|
<returns>true, if both <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> are not the same.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Explicit(System.Int32)~Syroot.NintenTools.Bfres.Decimal10x5">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Int32"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Explicit(System.Double)~Syroot.NintenTools.Bfres.Decimal10x5">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Double"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Explicit(System.Single)~Syroot.NintenTools.Bfres.Decimal10x5">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Single"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Explicit(Syroot.NintenTools.Bfres.Decimal10x5)~System.Double">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:System.Double"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> value to represent in the new <see cref="T:System.Double"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Explicit(Syroot.NintenTools.Bfres.Decimal10x5)~System.Int32">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:System.Int32"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> value to represent in the new <see cref="T:System.Int32"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.op_Explicit(Syroot.NintenTools.Bfres.Decimal10x5)~System.Single">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:System.Single"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> value to represent in the new <see cref="T:System.Single"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.Equals(System.Object)">
|
|
<summary>
|
|
Gets a value indicating whether this <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> is the same as the second specified
|
|
<see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<param name="obj">The object to compare, if it is a <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>true, if both <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> are the same.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.GetHashCode">
|
|
<summary>
|
|
Gets a hash code as an indication for object equality.
|
|
</summary>
|
|
<returns>The hash code.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.ToString">
|
|
<summary>
|
|
Gets a string describing this <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<returns>A string describing this <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Decimal10x5.Equals(Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Indicates whether the current <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> is equal to another <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.
|
|
</summary>
|
|
<param name="other">A <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> to compare with this <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/>.</param>
|
|
<returns>true if the current <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> is equal to the other parameter; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.DWord">
|
|
<summary>
|
|
Represents a 4-byte value which can hold differently typed data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.DWord.Int32">
|
|
<summary>
|
|
The data as an <see cref="F:Syroot.NintenTools.Bfres.DWord.Int32"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.DWord.Single">
|
|
<summary>
|
|
The data as a <see cref="F:Syroot.NintenTools.Bfres.DWord.Single"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.DWord.UInt32">
|
|
<summary>
|
|
The data as an <see cref="F:Syroot.NintenTools.Bfres.DWord.UInt32"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.op_Implicit(System.Int32)~Syroot.NintenTools.Bfres.DWord">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.DWord"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="F:Syroot.NintenTools.Bfres.DWord.Int32"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.DWord"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.op_Implicit(System.Single)~Syroot.NintenTools.Bfres.DWord">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.DWord"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="F:Syroot.NintenTools.Bfres.DWord.Single"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.DWord"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.op_Implicit(System.UInt32)~Syroot.NintenTools.Bfres.DWord">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.DWord"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="F:Syroot.NintenTools.Bfres.DWord.UInt32"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.DWord"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.op_Implicit(Syroot.NintenTools.Bfres.DWord)~System.Int32">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to an <see cref="F:Syroot.NintenTools.Bfres.DWord.Int32"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.DWord"/> value to represent in the new <see cref="F:Syroot.NintenTools.Bfres.DWord.Int32"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.op_Implicit(Syroot.NintenTools.Bfres.DWord)~System.Single">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="F:Syroot.NintenTools.Bfres.DWord.Single"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.DWord"/> value to represent in the new <see cref="F:Syroot.NintenTools.Bfres.DWord.Single"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.op_Implicit(Syroot.NintenTools.Bfres.DWord)~System.UInt32">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to an <see cref="F:Syroot.NintenTools.Bfres.DWord.UInt32"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.DWord"/> value to represent in the new <see cref="F:Syroot.NintenTools.Bfres.DWord.UInt32"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.GetTypeCode">
|
|
<summary>
|
|
Returns the <see cref="T:System.TypeCode"/> for this instance.
|
|
</summary>
|
|
<returns>The enumerated constant that is the <see cref="T:System.TypeCode"/> of the class or value type that
|
|
implements this interface.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToBoolean(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToByte(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToChar(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToDateTime(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToDecimal(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToDouble(System.IFormatProvider)">
|
|
<summary>
|
|
Converts the value of this instance to an equivalent double-precision floating-point number using the
|
|
specified culture-specific formatting information.
|
|
</summary>
|
|
<param name="provider">An <see cref="T:System.IFormatProvider"/> interface implementation that supplies
|
|
culture-specific formatting information.</param>
|
|
<returns>A double-precision floating-point number equivalent to the value of this instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToInt16(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToInt32(System.IFormatProvider)">
|
|
<summary>
|
|
Converts the value of this instance to an equivalent 32-bit signed integer using the specified
|
|
culture-specific formatting information.
|
|
</summary>
|
|
<param name="provider">An <see cref="T:System.IFormatProvider"/> interface implementation that supplies
|
|
culture-specific formatting information.</param>
|
|
<returns>An 32-bit signed integer equivalent to the value of this instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToInt64(System.IFormatProvider)">
|
|
<summary>
|
|
Converts the value of this instance to an equivalent 64-bit signed integer using the specified
|
|
culture-specific formatting information.
|
|
</summary>
|
|
<param name="provider">An <see cref="T:System.IFormatProvider"/> interface implementation that supplies
|
|
culture-specific formatting information.</param>
|
|
<returns>An 64-bit signed integer equivalent to the value of this instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToSByte(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToSingle(System.IFormatProvider)">
|
|
<summary>
|
|
Converts the value of this instance to an equivalent single-precision floating-point number using the
|
|
specified culture-specific formatting information.
|
|
</summary>
|
|
<param name="provider">An <see cref="T:System.IFormatProvider"/> interface implementation that supplies
|
|
culture-specific formatting information.</param>
|
|
<returns>A single-precision floating-point number equivalent to the value of this instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToString(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToType(System.Type,System.IFormatProvider)">
|
|
<summary>
|
|
Converts the value of this instance to an <see cref="T:System.Object"/> of the specified <see cref="T:System.Type"/> that has
|
|
an equivalent value, using the specified culture-specific formatting information.
|
|
</summary>
|
|
<param name="conversionType">The <see cref="T:System.Type"/> to which the value of this instance is converted.
|
|
</param>
|
|
<param name="provider">An <see cref="T:System.IFormatProvider"/> interface implementation that supplies
|
|
culture-specific formatting information.</param>
|
|
<returns>An <see cref="T:System.Object"/> instance of type conversionType whose value is equivalent to the value of
|
|
this instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToUInt16(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToUInt32(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.DWord.ToUInt64(System.IFormatProvider)">
|
|
<summary>
|
|
This operation is not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Half">
|
|
<summary>
|
|
Represents a 16-bit half-precision floating point value according to the IEEE 754 standard.
|
|
</summary>
|
|
<remarks>
|
|
Examples:
|
|
SEEEEEFF_FFFFFFFF
|
|
0b00000000_00000000 = 0
|
|
1b00000000_00000000 = -0
|
|
0b00111100_00000000 = 1
|
|
0b11000000_00000000 = -2
|
|
0b11111011_11111111 = 65504 (MaxValue)
|
|
0b01111100_00000000 = PositiveInfinity
|
|
0b11111100_00000000 = NegativeInfinity
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Half.Epsilon">
|
|
<summary>
|
|
Represents the smallest positive <see cref="T:Syroot.NintenTools.Bfres.Half"/> value greater than zero.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Half.MaxValue">
|
|
<summary>
|
|
Represents the largest possible value of <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Half.MinValue">
|
|
<summary>
|
|
Represents the smallest possible value of <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Half.NaN">
|
|
<summary>
|
|
Represents not a number (NaN).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Half.NegativeInfinity">
|
|
<summary>
|
|
Represents negative infinity.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Half.PositiveInfinity">
|
|
<summary>
|
|
Represents positive infinity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.#ctor(System.UInt16)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Half"/> struct from the given <paramref name="raw"/>
|
|
representation.
|
|
</summary>
|
|
<param name="raw">The raw representation of the internally stored bits.</param>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Half.Raw">
|
|
<summary>
|
|
Gets the internally stored value to represent the instance.
|
|
</summary>
|
|
<remarks>Signed to get arithmetic rather than logical shifts.</remarks>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_UnaryPlus(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Returns the given <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<param name="a">The <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>The result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Addition(Syroot.NintenTools.Bfres.Half,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Adds the first <see cref="T:Syroot.NintenTools.Bfres.Half"/> to the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>The addition result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_UnaryNegation(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Negates the given <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<param name="a">The <see cref="T:Syroot.NintenTools.Bfres.Half"/> to negate.</param>
|
|
<returns>The negated result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Subtraction(Syroot.NintenTools.Bfres.Half,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Subtracts the first <see cref="T:Syroot.NintenTools.Bfres.Half"/> from the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>The subtraction result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Multiply(Syroot.NintenTools.Bfres.Half,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Multiplicates the first <see cref="T:Syroot.NintenTools.Bfres.Half"/> by the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>The multiplication result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Division(Syroot.NintenTools.Bfres.Half,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Divides the first <see cref="T:Syroot.NintenTools.Bfres.Half"/> through the second one.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>The division result.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Equality(Syroot.NintenTools.Bfres.Half,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Gets a value indicating whether the first specified <see cref="T:Syroot.NintenTools.Bfres.Half"/> is the same as the second
|
|
specified <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Half"/> to compare.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Half"/> to compare.</param>
|
|
<returns>true, if both <see cref="T:Syroot.NintenTools.Bfres.Half"/> are the same.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Inequality(Syroot.NintenTools.Bfres.Half,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Gets a value indicating whether the first specified <see cref="T:Syroot.NintenTools.Bfres.Half"/> is not the same as the second
|
|
specified <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<param name="a">The first <see cref="T:Syroot.NintenTools.Bfres.Half"/> to compare.</param>
|
|
<param name="b">The second <see cref="T:Syroot.NintenTools.Bfres.Half"/> to compare.</param>
|
|
<returns>true, if both <see cref="T:Syroot.NintenTools.Bfres.Half"/> are not the same.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Explicit(System.Int32)~Syroot.NintenTools.Bfres.Half">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Int32"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.Half"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Explicit(System.Double)~Syroot.NintenTools.Bfres.Half">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Double"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.Half"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Explicit(System.Single)~Syroot.NintenTools.Bfres.Half">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Single"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.Half"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Implicit(Syroot.NintenTools.Bfres.Half)~System.Double">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:System.Double"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Half"/> value to represent in the new <see cref="T:System.Double"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Explicit(Syroot.NintenTools.Bfres.Half)~System.Int32">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:System.Int32"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Half"/> value to represent in the new <see cref="T:System.Int32"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.op_Implicit(Syroot.NintenTools.Bfres.Half)~System.Single">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:System.Single"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Half"/> value to represent in the new <see cref="T:System.Single"/>
|
|
instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.Equals(System.Object)">
|
|
<summary>
|
|
Gets a value indicating whether this <see cref="T:Syroot.NintenTools.Bfres.Half"/> is the same as the second specified
|
|
<see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<param name="obj">The object to compare, if it is a <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>true, if both <see cref="T:Syroot.NintenTools.Bfres.Half"/> are the same.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.GetHashCode">
|
|
<summary>
|
|
Gets a hash code as an indication for object equality.
|
|
</summary>
|
|
<returns>The hash code.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.ToString">
|
|
<summary>
|
|
Gets a string describing this <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<returns>A string describing this <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.Equals(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Indicates whether the current <see cref="T:Syroot.NintenTools.Bfres.Half"/> is equal to another <see cref="T:Syroot.NintenTools.Bfres.Half"/>.
|
|
</summary>
|
|
<param name="other">A <see cref="T:Syroot.NintenTools.Bfres.Half"/> to compare with this <see cref="T:Syroot.NintenTools.Bfres.Half"/>.</param>
|
|
<returns>true if the current <see cref="T:Syroot.NintenTools.Bfres.Half"/> is equal to the other parameter; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.IsNaN(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Returns a value indicating whether the specified number evaluates to not a number (<see cref="F:Syroot.NintenTools.Bfres.Half.NaN"/>).
|
|
</summary>
|
|
<param name="half">A half-precision floating-point number.</param>
|
|
<returns><c>true</c> if value evaluates to not a number (<see cref="F:Syroot.NintenTools.Bfres.Half.NaN"/>); otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.IsInfinity(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Returns a value indicating whether the specified number evaluates to negative or positive infinity.
|
|
</summary>
|
|
<param name="half">A half-precision floating-point number.</param>
|
|
<returns><c>true</c> if half evaluates to <see cref="F:Syroot.NintenTools.Bfres.Half.PositiveInfinity"/> or <see cref="F:Syroot.NintenTools.Bfres.Half.NegativeInfinity"/>;
|
|
otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.IsNegativeInfinity(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Returns a value indicating whether the specified number evaluates to negative infinity.
|
|
</summary>
|
|
<param name="half">A half-precision floating-point number.</param>
|
|
<returns><c>true</c> if half evaluates to <see cref="F:Syroot.NintenTools.Bfres.Half.NegativeInfinity"/>; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Half.IsPositiveInfinity(Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Returns a value indicating whether the specified number evaluates to positive infinity.
|
|
</summary>
|
|
<param name="half">A half-precision floating-point number.</param>
|
|
<returns><c>true</c> if half evaluates to <see cref="F:Syroot.NintenTools.Bfres.Half.PositiveInfinity"/>; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ResDict">
|
|
<summary>
|
|
Represents the non-generic base of a dictionary which can quickly look up <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instances via
|
|
key or index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResDict"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Count">
|
|
<summary>
|
|
Gets the number of instances stored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Keys">
|
|
<summary>
|
|
Gets all keys under which instances are stored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Values">
|
|
<summary>
|
|
Gets all stored instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Nodes">
|
|
<summary>
|
|
Returns only the publically visible nodes, excluding the root node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance stored at the specified <paramref name="index"/>.
|
|
</summary>
|
|
<param name="index">The 0-based index of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to get or set.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> at the specified <paramref name="index"/>.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The index is smaller than 0 or bigger or equal to
|
|
<see cref="P:Syroot.NintenTools.Bfres.ResDict.Count"/>.</exception>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Item(System.String)">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance stored under the specified <paramref name="key"/>.
|
|
</summary>
|
|
<param name="key">The textual key of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to get or set.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> with the specified <paramref name="key"/>.</returns>
|
|
<exception cref="T:System.ArgumentException">An <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance with the same <paramref name="key"/>
|
|
already exists.</exception>
|
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">An <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance with the given
|
|
<paramref name="key"/> does not exist.</exception>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict.Item(Syroot.NintenTools.Bfres.Core.IResData)">
|
|
<summary>
|
|
Gets or sets the key under which the specified <paramref name="instance"/> is stored.
|
|
</summary>
|
|
<param name="instance">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance of the key to get or set.</param>
|
|
<returns>The key of the specified <paramref name="instance"/>.</returns>
|
|
<exception cref="T:System.ArgumentException">An <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance with the same key already exists.
|
|
</exception>
|
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">A key for the given <paramref name="instance"/> does not exist.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.Clear">
|
|
<summary>
|
|
Removes all elements from the dictionary.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.ContainsKey(System.String)">
|
|
<summary>
|
|
Determines whether an instance is saved under the given <paramref name="key"/> in the dictionary.
|
|
</summary>
|
|
<param name="key">The textual key to locate in the dictionary. The value can be <c>null</c>.</param>
|
|
<returns><c>true</c> if <paramref name="key"/> was found in the dictionary; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.IndexOf(System.String)">
|
|
<summary>
|
|
Searches for the specified <paramref name="key"/> and returns the zero-based index of the first occurrence
|
|
within the entire dictionary.
|
|
</summary>
|
|
<param name="key">The textual key to locate in the dictionary. The value can be <c>null</c>.</param>
|
|
<returns>The zero-based index of the first occurence of <paramref name="key"/> within the entire dictionary
|
|
if found; otherwise <c>-1</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.Rename(System.String,System.String)">
|
|
<summary>
|
|
Changes the key of the instance currently saved under the given <paramref name="key"/> to the
|
|
<paramref name="newKey"/>.
|
|
</summary>
|
|
<param name="key">The current textual key to rename.</param>
|
|
<param name="newKey">The new textual key to use.</param>
|
|
<exception cref="T:System.ArgumentException">An <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance with the same
|
|
<paramref name="newKey"/> already exists.
|
|
</exception>
|
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The given <paramref name="key"/> does not exist.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.Remove(System.String)">
|
|
<summary>
|
|
Removes the first occurrence of the instance with the specific <paramref name="key"/> from the dictionary.
|
|
</summary>
|
|
<param name="key">The textual key of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance which will be removed.</param>
|
|
<returns><c>true</c> if the instance under <paramref name="key"/> was successfully removed; otherwise
|
|
<c>false</c>. This method also returns <c>false</c> if <paramref name="key"/> was not found in the
|
|
dictionary.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the instance at the specified <paramref name="index"/> of the dictionary.
|
|
</summary>
|
|
<param name="index">The zero-based index of the instance to remove.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0 or equal to or greater
|
|
than <see cref="P:Syroot.NintenTools.Bfres.ResDict.Count"/>.</exception>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.TryGetValue(System.String,Syroot.NintenTools.Bfres.Core.IResData@)">
|
|
<summary>
|
|
Returns <c>true</c> if an <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance was stored under the given <paramref name="key"/>
|
|
and has been assigned to <paramref name="value"/>, or <c>false</c> if no instance is stored under the
|
|
given <paramref name="key"/> and <c>null</c> was assigned to <paramref name="value"/>.
|
|
</summary>
|
|
<param name="key">The textual key of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to get or set.</param>
|
|
<param name="value">The variable receiving the found <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> or <c>null</c>.</param>
|
|
<returns><c>true</c> if an instance was found and assigned; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.Add(System.String,Syroot.NintenTools.Bfres.Core.IResData)">
|
|
<summary>
|
|
Adds the given <paramref name="value"/> under the specified <paramref name="key"/>.
|
|
</summary>
|
|
<param name="key">The textual key under which the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance will be stored.</param>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> to add.</param>
|
|
<exception cref="T:System.ArgumentException">An <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance with the same <paramref name="key"/>
|
|
already exists.</exception>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.ContainsValue(Syroot.NintenTools.Bfres.Core.IResData)">
|
|
<summary>
|
|
Determines whether the given <paramref name="value"/> is in the dictionary.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to locate in the dictionary. The value can be
|
|
<c>null</c>.</param>
|
|
<returns><c>true</c> if <paramref name="value"/> was found in the dictionary; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.IndexOf(Syroot.NintenTools.Bfres.Core.IResData)">
|
|
<summary>
|
|
Searches for the specified <paramref name="value"/> and returns the zero-based index of the first occurrence
|
|
within the entire dictionary.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to locate in the dictionary. The value can be
|
|
<c>null</c>.</param>
|
|
<returns>The zero-based index of the first occurence of <paramref name="value"/> within the entire
|
|
dictionary if found; otherwise <c>-1</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.Remove(Syroot.NintenTools.Bfres.Core.IResData)">
|
|
<summary>
|
|
Removes the first occurrence of a specific <paramref name="value"/> from the dictionary.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to remove from the dictionary. The value can be
|
|
<c>null</c>.</param>
|
|
<returns><c>true</c> if <paramref name="value"/> was successfully removed; otherwise <c>false</c>. This
|
|
method also returns <c>false</c> if <paramref name="value"/> was not found in the dictionary.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.ToArray">
|
|
<summary>
|
|
Copies the elements of the dictionary as <see cref="T:System.Collections.Generic.KeyValuePair`2"/> instances to a new
|
|
array and returns it.
|
|
</summary>
|
|
<returns>An array containing copies of the elements.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.TryGetKey(Syroot.NintenTools.Bfres.Core.IResData,System.String@)">
|
|
<summary>
|
|
Returns <c>true</c> if a key was found for the given <paramref name="value"/> and has been assigned to
|
|
<paramref name="key"/>, or <c>false</c> if no key was found for the value and <c>null</c> was assigned to
|
|
<paramref name="key"/>.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> to look up a key for.</param>
|
|
<param name="key">The variable receiving the found key or <c>null</c>.</param>
|
|
<returns><c>true</c> if a key was found and assigned; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,Syroot#NintenTools#Bfres#Core#IResData}}#GetEnumerator">
|
|
<summary>
|
|
Returns a generic <see cref="T:System.Collections.IEnumerator"/> which can be used to iterate over the items in the dictionary.
|
|
</summary>
|
|
<returns>An enumerator to iterate over the items in the dictionary.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Returns an <see cref="T:System.Collections.IEnumerator"/> which can be used to iterate over the items in the dictionary.
|
|
</summary>
|
|
<returns>An enumerator to iterate over the items in the dictionary.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.Traverse(System.String)">
|
|
<summary>
|
|
Returns the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance of the node with the given <paramref name="name"/> using the
|
|
Patricia trie logic.
|
|
</summary>
|
|
<remarks>Nodes are looked up linearly by iterating over the node list internally, this method has been
|
|
implemented for test and validation purposes only.</remarks>
|
|
<param name="name">The name of the node to look up.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance referenced by the found node.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict.LoadNodeValue(Syroot.NintenTools.Bfres.Core.ResFileLoader)">
|
|
<summary>
|
|
Loads an <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance from the given <paramref name="loader"/>.
|
|
</summary>
|
|
<param name="loader">The <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileLoader"/> to load the instance with.</param>
|
|
<returns>The loaded <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ResDict.Node">
|
|
<summary>
|
|
Represents a node forming the Patricia trie of the dictionary.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ResDict`1">
|
|
<summary>
|
|
Represents a dictionary which can quickly look up <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instances of type
|
|
<typeparamref name="T"/> via key or index.
|
|
</summary>
|
|
<typeparam name="T">The specialized type of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instances.</typeparam>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict`1.Values">
|
|
<summary>
|
|
Gets all stored instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the value stored at the specified <paramref name="index"/>.
|
|
</summary>
|
|
<param name="index">The 0-based index of the instance to get or set.</param>
|
|
<returns>The instance at the specified <paramref name="index"/>.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The index is smaller than 0 or bigger or equal to
|
|
<see cref="P:Syroot.NintenTools.Bfres.ResDict.Count"/>.</exception>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResDict`1.Item(System.String)">
|
|
<summary>
|
|
Gets or sets the value stored under the specified <paramref name="key"/>.
|
|
</summary>
|
|
<param name="key">The textual key of the instance to get or set.</param>
|
|
<returns>The instance with the specified <paramref name="key"/>.</returns>
|
|
<exception cref="T:System.ArgumentException">An instance with the same <paramref name="key"/> already exists.
|
|
</exception>
|
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">An instance with the given <paramref name="key"/> does not exist.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.Add(System.String,`0)">
|
|
<summary>
|
|
Adds the given <paramref name="value"/> under the specified <paramref name="key"/>.
|
|
</summary>
|
|
<param name="key">The textual key under which the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance will be stored.</param>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> to add.</param>
|
|
<exception cref="T:System.ArgumentException">An <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance with the same <paramref name="key"/>
|
|
already exists.</exception>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.ContainsValue(`0)">
|
|
<summary>
|
|
Determines whether the given <paramref name="value"/> is in the dictionary.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to locate in the dictionary. The value can be
|
|
<c>null</c>.</param>
|
|
<returns><c>true</c> if <paramref name="value"/> was found in the dictionary; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.GetEnumerator">
|
|
<summary>
|
|
Returns a generic <see cref="T:System.Collections.IEnumerator"/> which can be used to iterate over the items in the dictionary.
|
|
</summary>
|
|
<returns>An enumerator to iterate over the items in the dictionary.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.IndexOf(`0)">
|
|
<summary>
|
|
Searches for the specified <paramref name="value"/> and returns the zero-based index of the first occurrence
|
|
within the entire dictionary.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to locate in the dictionary. The value can be
|
|
<c>null</c>.</param>
|
|
<returns>The zero-based index of the first occurence of <paramref name="value"/> within the entire
|
|
dictionary if found; otherwise <c>-1</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.Remove(`0)">
|
|
<summary>
|
|
Removes the first occurrence of a specific <paramref name="value"/> from the dictionary.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance to remove from the dictionary. The value can be
|
|
<c>null</c>.</param>
|
|
<returns><c>true</c> if <paramref name="value"/> was successfully removed; otherwise <c>false</c>. This
|
|
method also returns <c>false</c> if <paramref name="value"/> was not found in the dictionary.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.ToArray">
|
|
<summary>
|
|
Copies the elements of the dictionary as <see cref="T:System.Collections.Generic.KeyValuePair`2"/> instances to a new
|
|
array and returns it.
|
|
</summary>
|
|
<returns>An array containing copies of the elements.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.TryGetKey(`0,System.String@)">
|
|
<summary>
|
|
Returns <c>true</c> if a key was found for the given <paramref name="value"/> and has been assigned to
|
|
<paramref name="key"/>, or <c>false</c> if no key was found for the value and <c>null</c> was assigned to
|
|
<paramref name="key"/>.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> to look up a key for.</param>
|
|
<param name="key">The variable receiving the found key or <c>null</c>.</param>
|
|
<returns><c>true</c> if a key was found and assigned; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.TryGetValue(System.String,`0@)">
|
|
<summary>
|
|
Returns <c>true</c> if an instance was stored under the given <paramref name="key"/> and has been assigned
|
|
to <paramref name="value"/>, or <c>false</c> if no instance is stored under the given <paramref name="key"/>
|
|
and <c>null</c> was assigned to <paramref name="value"/>.
|
|
</summary>
|
|
<param name="key">The textual key of the instance to get or set.</param>
|
|
<param name="value">The variable receiving the found instance or <c>null</c>.</param>
|
|
<returns><c>true</c> if an instance was found and assigned; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResDict`1.LoadNodeValue(Syroot.NintenTools.Bfres.Core.ResFileLoader)">
|
|
<summary>
|
|
Loads an <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance from the given <paramref name="loader"/>.
|
|
</summary>
|
|
<param name="loader">The <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileLoader"/> to load the instance with.</param>
|
|
<returns>The loaded <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ResString">
|
|
<summary>
|
|
Represents a <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> which is stored in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResString.String">
|
|
<summary>
|
|
The textual <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> represented by this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResString.Encoding">
|
|
<summary>
|
|
The <see cref="P:Syroot.NintenTools.Bfres.ResString.Encoding"/> with which this string was read or will be written.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResString.op_Implicit(System.String)~Syroot.NintenTools.Bfres.ResString">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to a <see cref="T:Syroot.NintenTools.Bfres.ResString"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> value to represent in the new <see cref="T:Syroot.NintenTools.Bfres.ResString"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResString.op_Implicit(Syroot.NintenTools.Bfres.ResString)~System.String">
|
|
<summary>
|
|
Converts the given <paramref name="value"/> value to an <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> instance.
|
|
</summary>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.ResString"/> value to represent in the new <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> instance.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResString.ToString">
|
|
<summary>
|
|
Returns the value of the <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> property.
|
|
</summary>
|
|
<returns>The value of the <see cref="P:Syroot.NintenTools.Bfres.ResString.String"/> property.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.SetProperty.SetBrowsableProperty``1(System.String,System.Boolean)">
|
|
<summary>
|
|
Set the Browsable property.
|
|
NOTE: Be sure to decorate the property with [Browsable(true)]
|
|
</summary>
|
|
<param name="PropertyName">Name of the variable</param>
|
|
<param name="bIsBrowsable">Browsable Value</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.SetProperty.SetBrowsableProperty``1(``0,System.String,System.Boolean)">
|
|
<summary>
|
|
Set the Browsable property.
|
|
NOTE: Be sure to decorate the property with [Browsable(true)]
|
|
</summary>
|
|
<param name="obj">An instance of the object whose property should be modified.</param>
|
|
<param name="PropertyName">Name of the variable</param>
|
|
<param name="bIsBrowsable">Browsable Value</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Srt2D">
|
|
<summary>
|
|
Represents a 2D transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt2D.SizeInBytes">
|
|
<summary>
|
|
The size of this structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt2D.Scaling">
|
|
<summary>
|
|
The scaling amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt2D.Rotation">
|
|
<summary>
|
|
The rotation angle of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt2D.Translation">
|
|
<summary>
|
|
The translation amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Srt3D">
|
|
<summary>
|
|
Represents a 3D transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt3D.SizeInBytes">
|
|
<summary>
|
|
The size of this structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt3D.Scaling">
|
|
<summary>
|
|
The scaling amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt3D.Rotation">
|
|
<summary>
|
|
The rotation amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Srt3D.Translation">
|
|
<summary>
|
|
The translation amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TexSrt">
|
|
<summary>
|
|
Represents a 2D texture transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrt.SizeInBytes">
|
|
<summary>
|
|
The size of this structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrt.Mode">
|
|
<summary>
|
|
The <see cref="T:Syroot.NintenTools.Bfres.TexSrtMode"/> with which the transformation is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrt.Scaling">
|
|
<summary>
|
|
The scaling amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrt.Rotation">
|
|
<summary>
|
|
The rotation angle of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrt.Translation">
|
|
<summary>
|
|
The translation amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrt.unkown">
|
|
<summary>
|
|
Unkown space used in some games
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TexSrtEx">
|
|
<summary>
|
|
Represents a 2D texture transformation which is multiplied by a 3x4 matrix referenced at runtime by the
|
|
<see cref="F:Syroot.NintenTools.Bfres.TexSrtEx.MatrixPointer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrtEx.SizeInBytes">
|
|
<summary>
|
|
The size of this structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrtEx.Mode">
|
|
<summary>
|
|
The <see cref="T:Syroot.NintenTools.Bfres.TexSrtMode"/> with which the transformation is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrtEx.Scaling">
|
|
<summary>
|
|
The scaling amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrtEx.Rotation">
|
|
<summary>
|
|
The rotation angle of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrtEx.Translation">
|
|
<summary>
|
|
The translation amount of the transformation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexSrtEx.MatrixPointer">
|
|
<summary>
|
|
A pointer to a 3x4 matrix to multiply the transformation with. Set at runtime.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TexSrtMode">
|
|
<summary>
|
|
Represents the texture transformation mode used in <see cref="T:Syroot.NintenTools.Bfres.TexSrt"/> and <see cref="T:Syroot.NintenTools.Bfres.TexSrtEx"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TextureRef">
|
|
<summary>
|
|
Represents a reference to a <see cref="P:Syroot.NintenTools.Bfres.TextureRef.Texture"/> instance by name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.TextureRef.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.TextureRef"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TextureRef.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances. Typically the same as the <see cref="P:Syroot.NintenTools.Bfres.Texture.Name"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TextureRef.Texture">
|
|
<summary>
|
|
The referenced <see cref="P:Syroot.NintenTools.Bfres.TextureRef.Texture"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.UserData">
|
|
<summary>
|
|
Represents custom user variables which can be attached to many sections and subfiles of a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.UserData"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.UserData.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.UserData.Type">
|
|
<summary>
|
|
The data type of the stored values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.GetValueInt32Array">
|
|
<summary>
|
|
Returns the stored value as an array of <see cref="T:System.Int32"/> instances when the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.Int32"/>.
|
|
</summary>
|
|
<returns>The typed value.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.GetValueSingleArray">
|
|
<summary>
|
|
Returns the stored value as an array of <see cref="T:System.Single"/> instances when the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.Single"/>.
|
|
</summary>
|
|
<returns>The typed value.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.GetValueStringArray">
|
|
<summary>
|
|
Returns the stored value as an array of <see cref="T:System.String"/> instances when the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.String"/> or <see cref="F:Syroot.NintenTools.Bfres.UserDataType.WString"/>.
|
|
</summary>
|
|
<returns>The typed value.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.GetValueByteArray">
|
|
<summary>
|
|
Returns the stored value as an array of <see cref="T:System.Byte"/> instances when the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.Byte"/>.
|
|
</summary>
|
|
<returns>The typed value.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.SetValue(System.Int32[])">
|
|
<summary>
|
|
Sets the stored <paramref name="value"/> as an <see cref="T:System.Int32"/> array and the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.Int32"/>
|
|
</summary>
|
|
<param name="value">The value to store.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.SetValue(System.Single[])">
|
|
<summary>
|
|
Sets the stored <paramref name="value"/> as a <see cref="T:System.Single"/> array and the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.Single"/>
|
|
</summary>
|
|
<param name="value">The value to store.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.SetValue(System.String[],System.Boolean)">
|
|
<summary>
|
|
Sets the stored <paramref name="value"/> as a <see cref="T:System.String"/> array and the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.String"/> or <see cref="F:Syroot.NintenTools.Bfres.UserDataType.WString"/> depending on
|
|
<paramref name="asUnicode"/>.
|
|
</summary>
|
|
<param name="asUnicode"><c>true</c> to store data as UTF-16 encoded strings, or <c>false</c> to store it
|
|
as ASCII encoded strings.</param>
|
|
<param name="value">The value to store.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.UserData.SetValue(System.Byte[])">
|
|
<summary>
|
|
Sets the stored <paramref name="value"/> as a <see cref="T:System.Byte"/> array and the <see cref="P:Syroot.NintenTools.Bfres.UserData.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.UserDataType.Byte"/>
|
|
</summary>
|
|
<param name="value">The value to store.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.UserDataType">
|
|
<summary>
|
|
Represents the possible data types of values stored in <see cref="T:Syroot.NintenTools.Bfres.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.UserDataType.Int32">
|
|
<summary>
|
|
The values is an <see cref="F:Syroot.NintenTools.Bfres.UserDataType.Int32"/> array.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.UserDataType.Single">
|
|
<summary>
|
|
The values is a <see cref="F:Syroot.NintenTools.Bfres.UserDataType.Single"/> array.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.UserDataType.String">
|
|
<summary>
|
|
The values is a <see cref="F:Syroot.NintenTools.Bfres.UserDataType.String"/> array encoded in ASCII.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.UserDataType.WString">
|
|
<summary>
|
|
The values is a <see cref="F:Syroot.NintenTools.Bfres.UserDataType.String"/> array encoded in UTF-16.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.UserDataType.Byte">
|
|
<summary>
|
|
The values is a <see cref="F:Syroot.NintenTools.Bfres.UserDataType.Byte"/> array.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions">
|
|
<summary>
|
|
Represents extension methods for the <see cref="T:Syroot.BinaryData.BinaryDataReader"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadAnimConstant(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadAnimConstants(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadBounding(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadBoundings(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadDecimal10x5(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadDecimal10x5s(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadHalf(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadHalfs(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.NintenTools.Bfres.Half"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Half"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadMatrix3x4(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Matrix3x4"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Matrix3x4"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadMatrix3x4s(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Matrix3x4"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Matrix3x4"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector2"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2s(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector2"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2Bool(Syroot.BinaryData.BinaryDataReader,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector2Bool"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2Bool"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2Bools(Syroot.BinaryData.BinaryDataReader,System.Int32,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector2Bool"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2Bool"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2F(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector2F"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2F"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2Fs(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector2F"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2F"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2U(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector2U"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2U"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector2Us(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector2U"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector2U"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector3"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3s(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector3"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3Bool(Syroot.BinaryData.BinaryDataReader,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector3Bool"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3Bool"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3Bools(Syroot.BinaryData.BinaryDataReader,System.Int32,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector3Bool"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3Bool"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3F(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector3F"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3F"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3Fs(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector3F"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3F"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3U(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector3U"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3U"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector3Us(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector3U"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector3U"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector4"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4s(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector4"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4Bool(Syroot.BinaryData.BinaryDataReader,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector4Bool"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4Bool"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4Bools(Syroot.BinaryData.BinaryDataReader,System.Int32,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector4Bool"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4Bool"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4F(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector4F"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4F"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4Fs(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector4F"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4F"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4U(Syroot.BinaryData.BinaryDataReader)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector4U"/> instance from the current stream and returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4U"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadVector4Us(Syroot.BinaryData.BinaryDataReader,System.Int32)">
|
|
<summary>
|
|
Reads <see cref="T:Syroot.Maths.Vector4U"/> instances from the current stream and returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4U"/> instances.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.GetGX2AttribCallback(Syroot.BinaryData.BinaryDataReader,Syroot.NintenTools.Bfres.GX2.GX2AttribFormat)">
|
|
<summary>
|
|
Returns the conversion delegate for converting data available in the given <paramref name="attribFormat"/>
|
|
into a <see cref="T:Syroot.Maths.Vector4F"/> instance. Useful to prevent repetitive lookup for multiple values.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="attribFormat">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> of the data.</param>
|
|
<returns>A conversion delegate for the data.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadGX2Attrib(Syroot.BinaryData.BinaryDataReader,Syroot.NintenTools.Bfres.GX2.GX2AttribFormat)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector4F"/> instance converted from the given <paramref name="attribFormat"/> and
|
|
returns it.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="attribFormat">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> of the data.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4F"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataReaderExtensions.ReadGX2Attribs(Syroot.BinaryData.BinaryDataReader,System.Int32,Syroot.NintenTools.Bfres.GX2.GX2AttribFormat)">
|
|
<summary>
|
|
Reads a <see cref="T:Syroot.Maths.Vector4F"/> instances converted from the given <paramref name="attribFormat"/> and
|
|
returns them.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataReader"/>.</param>
|
|
<param name="count">The number of instances to read.</param>
|
|
<param name="attribFormat">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> of the data.</param>
|
|
<returns>The <see cref="T:Syroot.Maths.Vector4F"/> instances.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions">
|
|
<summary>
|
|
Represents extension methods for the <see cref="T:Syroot.BinaryData.BinaryDataWriter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.NintenTools.Bfres.AnimConstant)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.NintenTools.Bfres.AnimConstant})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.NintenTools.Bfres.Bounding)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.NintenTools.Bfres.Bounding})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.NintenTools.Bfres.Bounding"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.NintenTools.Bfres.Decimal10x5)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.NintenTools.Bfres.Decimal10x5})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.NintenTools.Bfres.Decimal10x5"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.NintenTools.Bfres.Half)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.NintenTools.Bfres.Half"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.NintenTools.Bfres.Half})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.NintenTools.Bfres.Half"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.NintenTools.Bfres.Half"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Matrix3x4)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Matrix3x4"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Matrix3x4"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Matrix3x4})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Matrix3x4"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Matrix3x4"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector2Bool,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector2Bool"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector2Bool"/> instance.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector2Bool},Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector2Bool"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector2Bool"/> instances.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector2F)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector2F"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector2F"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector2F})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector2F"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector2F"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector2U)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector2U"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector2U"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector2U})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector2U"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector2U"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector3)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector3"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector3"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector3})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector3"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector3"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector3Bool,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector3Bool"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector3Bool"/> instance.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector3Bool},Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector3Bool"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector3Bool"/> instances.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector3F)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector3F"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector3F"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector3F})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector3F"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector3F"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector3U)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector3U"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector3U"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector3U})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector3U"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector3U"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector4)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector4"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector4"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector4})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector4"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector4"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector4Bool,Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector4Bool"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector4Bool"/> instance.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector4Bool},Syroot.BinaryData.BinaryBooleanFormat)">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector4Bool"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector4Bool"/> instances.</param>
|
|
<param name="format">The <see cref="T:Syroot.BinaryData.BinaryBooleanFormat"/> in which values are stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector4F)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector4F"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector4F"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector4F})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector4F"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector4F"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector4U)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector4U"/> instance into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector4U"/> instance.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector4U})">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector4U"/> instances into the current stream.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector4U"/> instances.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.GetGX2AttribCallback(Syroot.BinaryData.BinaryDataWriter,Syroot.NintenTools.Bfres.GX2.GX2AttribFormat)">
|
|
<summary>
|
|
Returns the conversion delegate for converting data available in the given <paramref name="attribFormat"/>
|
|
from a <see cref="T:Syroot.Maths.Vector4F"/> instance. Useful to prevent repetitive lookup for multiple values.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="attribFormat">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> of the data.</param>
|
|
<returns>A conversion delegate for the data.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,Syroot.Maths.Vector4F,Syroot.NintenTools.Bfres.GX2.GX2AttribFormat)">
|
|
<summary>
|
|
Writes a <see cref="T:Syroot.Maths.Vector4U"/> instance into the current stream with the given
|
|
<paramref name="attribFormat"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="value">The <see cref="T:Syroot.Maths.Vector4F"/> instance.</param>
|
|
<param name="attribFormat">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> of the data.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.BinaryDataWriterExtensions.Write(Syroot.BinaryData.BinaryDataWriter,System.Collections.Generic.IEnumerable{Syroot.Maths.Vector4F},Syroot.NintenTools.Bfres.GX2.GX2AttribFormat)">
|
|
<summary>
|
|
Writes <see cref="T:Syroot.Maths.Vector4U"/> instances into the current stream with the given
|
|
<paramref name="attribFormat"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:Syroot.BinaryData.BinaryDataWriter"/>.</param>
|
|
<param name="values">The <see cref="T:Syroot.Maths.Vector4U"/> instances.</param>
|
|
<param name="attribFormat">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> of the data.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.ByteExtensions">
|
|
<summary>
|
|
Represents extension methods for <see cref="T:System.Byte"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.Decode(System.Byte,System.Int32,System.Int32)">
|
|
<summary>
|
|
Returns an <see cref="T:System.Byte"/> instance represented by the given number of <paramref name="bits"/>, starting
|
|
at the <paramref name="firstBit"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="firstBit">The first bit of the encoded value.</param>
|
|
<param name="bits">The number of least significant bits which are used to store the <see cref="T:System.Byte"/>
|
|
value.</param>
|
|
<returns>The decoded <see cref="T:System.Byte"/>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.EnableBit(System.Byte,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.Byte"/> with the bit at the <paramref name="index"/> set (being 1).
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to enable.</param>
|
|
<returns>The current <see cref="T:System.Byte"/> with the bit enabled.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.Encode(System.Byte,System.Byte,System.Int32,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.Byte"/> with the given <paramref name="value"/> set into the given number
|
|
of <paramref name="bits"/> starting at <paramref name="firstBit"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="value">The value to encode.</param>
|
|
<param name="firstBit">The first bit used for the encoded value.</param>
|
|
<param name="bits">The number of bits which are used to store the <see cref="T:System.Byte"/> value.</param>
|
|
<returns>The current <see cref="T:System.Byte"/> with the value encoded into it.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.DisableBit(System.Byte,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.Byte"/> with the bit at the <paramref name="index"/> cleared (being 0).
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to disable.</param>
|
|
<returns>The current <see cref="T:System.Byte"/> with the bit disabled.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.GetBit(System.Byte,System.Int32)">
|
|
<summary>
|
|
Returns a value indicating whether the bit at the <paramref name="index"/> in the current
|
|
<see cref="T:System.Byte"/> is enabled or disabled.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to check.</param>
|
|
<returns><c>true</c> when the bit is set; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.RotateBits(System.Byte,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.Byte"/> with all bits rotated in the given <paramref name="direction"/>,
|
|
where positive directions rotate left and negative directions rotate right.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="direction">The direction in which to rotate, where positive directions rotate left.</param>
|
|
<returns>The current <see cref="T:System.Byte"/> with the bits rotated.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.SetBit(System.Byte,System.Int32,System.Boolean)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.Byte"/> with the bit at the <paramref name="index"/> enabled or disabled,
|
|
according to <paramref name="enable"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to enable or disable.</param>
|
|
<param name="enable"><c>true</c> to enable the bit; otherwise <c>false</c>.</param>
|
|
<returns>The current <see cref="T:System.Byte"/> with the bit enabled or disabled.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ByteExtensions.ToggleBit(System.Byte,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.Byte"/> with the bit at the <paramref name="index"/> enabled when it is
|
|
disabled or disabled when it is enabled.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.Byte"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to toggle.</param>
|
|
<returns>The current <see cref="T:System.Byte"/> with the bit toggled.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.UInt32Extensions">
|
|
<summary>
|
|
Represents extension methods for <see cref="T:System.UInt32"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.Decode(System.UInt32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Returns an <see cref="T:System.UInt32"/> instance represented by the given number of <paramref name="bits"/>, starting
|
|
at the <paramref name="firstBit"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="firstBit">The first bit of the encoded value.</param>
|
|
<param name="bits">The number of least significant bits which are used to store the <see cref="T:System.UInt32"/>
|
|
value.</param>
|
|
<returns>The decoded <see cref="T:System.UInt32"/>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.EnableBit(System.UInt32,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.UInt32"/> with the bit at the <paramref name="index"/> set (being 1).
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to enable.</param>
|
|
<returns>The current <see cref="T:System.UInt32"/> with the bit enabled.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.Encode(System.UInt32,System.UInt32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.UInt32"/> with the given <paramref name="value"/> set into the given number
|
|
of <paramref name="bits"/> starting at <paramref name="firstBit"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="value">The value to encode.</param>
|
|
<param name="firstBit">The first bit used for the encoded value.</param>
|
|
<param name="bits">The number of bits which are used to store the <see cref="T:System.UInt32"/> value.</param>
|
|
<returns>The current <see cref="T:System.UInt32"/> with the value encoded into it.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.DisableBit(System.UInt32,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.UInt32"/> with the bit at the <paramref name="index"/> cleared (being 0).
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to disable.</param>
|
|
<returns>The current <see cref="T:System.UInt32"/> with the bit disabled.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.GetBit(System.UInt32,System.Int32)">
|
|
<summary>
|
|
Returns a value indicating whether the bit at the <paramref name="index"/> in the current
|
|
<see cref="T:System.UInt32"/> is enabled or disabled.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to check.</param>
|
|
<returns><c>true</c> when the bit is set; otherwise <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.RotateBits(System.UInt32,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.UInt32"/> with all bits rotated in the given <paramref name="direction"/>,
|
|
where positive directions rotate left and negative directions rotate right.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="direction">The direction in which to rotate, where positive directions rotate left.</param>
|
|
<returns>The current <see cref="T:System.UInt32"/> with the bits rotated.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.SetBit(System.UInt32,System.Int32,System.Boolean)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.UInt32"/> with the bit at the <paramref name="index"/> enabled or disabled,
|
|
according to <paramref name="enable"/>.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to enable or disable.</param>
|
|
<param name="enable"><c>true</c> to enable the bit; otherwise <c>false</c>.</param>
|
|
<returns>The current <see cref="T:System.UInt32"/> with the bit enabled or disabled.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.UInt32Extensions.ToggleBit(System.UInt32,System.Int32)">
|
|
<summary>
|
|
Returns the current <see cref="T:System.UInt32"/> with the bit at the <paramref name="index"/> enabled when it is
|
|
disabled or disabled when it is enabled.
|
|
</summary>
|
|
<param name="self">The extended <see cref="T:System.UInt32"/> instance.</param>
|
|
<param name="index">The 0-based index of the bit to toggle.</param>
|
|
<returns>The current <see cref="T:System.UInt32"/> with the bit toggled.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.IFilePortable">
|
|
<summary>
|
|
Represents the common interface for exporting <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> data instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.IFilePortable.Export(System.String,Syroot.NintenTools.Bfres.ResFile)">
|
|
<summary>
|
|
Loads raw data from the <paramref name="loader"/> data stream into instances.
|
|
</summary>
|
|
<param name="loader">The <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileLoader"/> to load data with.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.IFilePortable.Import(System.String,Syroot.NintenTools.Bfres.ResFile)">
|
|
<summary>
|
|
Saves header data of the instance and queues referenced data in the given <paramref name="saver"/>.
|
|
</summary>
|
|
<param name="saver">The <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileSaver"/> to save headers and queue data with.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.IResData">
|
|
<summary>
|
|
Represents the common interface for <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> data instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.IResData.Load(Syroot.NintenTools.Bfres.Core.ResFileLoader)">
|
|
<summary>
|
|
Loads raw data from the <paramref name="loader"/> data stream into instances.
|
|
</summary>
|
|
<param name="loader">The <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileLoader"/> to load data with.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.IResData.Save(Syroot.NintenTools.Bfres.Core.ResFileSaver)">
|
|
<summary>
|
|
Saves header data of the instance and queues referenced data in the given <paramref name="saver"/>.
|
|
</summary>
|
|
<param name="saver">The <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileSaver"/> to save headers and queue data with.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.ResFileLoader">
|
|
<summary>
|
|
Loads the hierachy and data of a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.#ctor(Syroot.NintenTools.Bfres.ResFile,System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileLoader"/> class loading data into the given
|
|
<paramref name="resFile"/> from the specified <paramref name="stream"/> which is optionally left open.
|
|
</summary>
|
|
<param name="resFile">The <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> instance to load data into.</param>
|
|
<param name="stream">The <see cref="T:System.IO.Stream"/> to read data from.</param>
|
|
<param name="leaveOpen"><c>true</c> to leave the stream open after reading, otherwise <c>false</c>.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.#ctor(Syroot.NintenTools.Bfres.ResFile,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileLoader"/> class from the file with the given
|
|
<paramref name="fileName"/>.
|
|
</summary>
|
|
<param name="resFile">The <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> instance to load data into.</param>
|
|
<param name="fileName">The name of the file to load the data from.</param>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Core.ResFileLoader.ResFile">
|
|
<summary>
|
|
Gets the loaded <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.Execute">
|
|
<summary>
|
|
Starts deserializing the data from the <see cref="P:Syroot.NintenTools.Bfres.Core.ResFileLoader.ResFile"/> root.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.Load``1">
|
|
<summary>
|
|
Reads and returns an <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance of type <typeparamref name="T"/> from the following
|
|
offset or returns <c>null</c> if the read offset is 0.
|
|
</summary>
|
|
<typeparam name="T">The type of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> to read.</typeparam>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> instance or <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.LoadCustom``1(System.Func{``0},System.Nullable{System.UInt32})">
|
|
<summary>
|
|
Reads and returns an instance of arbitrary type <typeparamref name="T"/> from the following offset with the
|
|
given <paramref name="callback"/> or returns <c>null</c> if the read offset is 0.
|
|
</summary>
|
|
<typeparam name="T">The type of the data to read.</typeparam>
|
|
<param name="callback">The callback to read the instance data with.</param>
|
|
<param name="offset">The optional offset to use instead of reading a following one.</param>
|
|
<returns>The data instance or <c>null</c>.</returns>
|
|
<remarks>Offset required for ExtFile header (offset specified before size).</remarks>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.LoadDict``1">
|
|
<summary>
|
|
Reads and returns an <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instance with elements of type <typeparamref name="T"/> from
|
|
the following offset or returns an empty instance if the read offset is 0.
|
|
</summary>
|
|
<typeparam name="T">The type of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> elements.</typeparam>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instance.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.LoadList``1(System.Int32,System.Nullable{System.UInt32})">
|
|
<summary>
|
|
Reads and returns an <see cref="T:System.Collections.Generic.IList`1"/> instance with <paramref name="count"/> elements of type
|
|
<typeparamref name="T"/> from the following offset or returns <c>null</c> if the read offset is 0.
|
|
</summary>
|
|
<typeparam name="T">The type of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> elements.</typeparam>
|
|
<param name="count">The number of elements to expect for the list.</param>
|
|
<param name="offset">The optional offset to use instead of reading a following one.</param>
|
|
<returns>The <see cref="T:System.Collections.Generic.IList`1"/> instance or <c>null</c>.</returns>
|
|
<remarks>Offset required for FMDL FVTX lists (offset specified before count).</remarks>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.LoadString(System.Text.Encoding)">
|
|
<summary>
|
|
Reads and returns a <see cref="T:System.String"/> instance from the following offset or <c>null</c> if the read
|
|
offset is 0.
|
|
</summary>
|
|
<param name="encoding">The optional encoding of the text.</param>
|
|
<returns>The read text.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.LoadStrings(System.Int32,System.Text.Encoding)">
|
|
<summary>
|
|
Reads and returns <paramref name="count"/> <see cref="T:System.String"/> instances from the following offsets.
|
|
</summary>
|
|
<param name="count">The number of instances to read.</param>
|
|
<param name="encoding">The optional encoding of the texts.</param>
|
|
<returns>The read texts.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.CheckSignature(System.String)">
|
|
<summary>
|
|
Reads a BFRES signature consisting of 4 ASCII characters encoded as an <see cref="T:System.UInt32"/> and checks for
|
|
validity.
|
|
</summary>
|
|
<param name="validSignature">A valid signature.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.ReadOffset">
|
|
<summary>
|
|
Reads a BFRES offset which is relative to itself, and returns the absolute address.
|
|
</summary>
|
|
<returns>The absolute address of the offset.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileLoader.ReadOffsets(System.Int32)">
|
|
<summary>
|
|
Reads BFRES offsets which are relative to themselves, and returns the absolute addresses.
|
|
</summary>
|
|
<param name="count">The number of offsets to read.</param>
|
|
<returns>The absolute addresses of the offsets.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.ResFileSaver">
|
|
<summary>
|
|
Saves the hierachy and data of a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Core.ResFileSaver.AlignmentSmall">
|
|
<summary>
|
|
Gets or sets a data block alignment typically seen with <see cref="P:Syroot.NintenTools.Bfres.Buffer.Data"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.#ctor(Syroot.NintenTools.Bfres.ResFile,System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileSaver"/> class saving data from the given
|
|
<paramref name="resFile"/> into the specified <paramref name="stream"/> which is optionally left open.
|
|
</summary>
|
|
<param name="resFile">The <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> instance to save data from.</param>
|
|
<param name="stream">The <see cref="T:System.IO.Stream"/> to save data into.</param>
|
|
<param name="leaveOpen"><c>true</c> to leave the stream open after writing, otherwise <c>false</c>.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.#ctor(Syroot.NintenTools.Bfres.ResFile,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Core.ResFileSaver"/> class for the file with the given
|
|
<paramref name="fileName"/>.
|
|
</summary>
|
|
<param name="resFile">The <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> instance to save.</param>
|
|
<param name="fileName">The name of the file to save the data into.</param>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Core.ResFileSaver.ResFile">
|
|
<summary>
|
|
Gets the saved <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Core.ResFileSaver.ExportableData">
|
|
<summary>
|
|
Gets the saved <see cref="!:Bfres.IResData"/> instance used for exporting data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Core.ResFileSaver.CurrentIndex">
|
|
<summary>
|
|
Gets the current index when writing lists or dicts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.Execute">
|
|
<summary>
|
|
Starts serializing the data from the <see cref="P:Syroot.NintenTools.Bfres.Core.ResFileSaver.ResFile"/> root.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.Save(Syroot.NintenTools.Bfres.Core.IResData,System.Int32)">
|
|
<summary>
|
|
Reserves space for an offset to the <paramref name="resData"/> written later.
|
|
</summary>
|
|
<param name="resData">The <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> to save.</param>
|
|
<param name="index">The index of the element, used for instances referenced by a <see cref="T:Syroot.NintenTools.Bfres.ResDict"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveFieldFileSize">
|
|
<summary>
|
|
Reserves space for the <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> file size field which is automatically filled later.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveFieldStringPool">
|
|
<summary>
|
|
Reserves space for the <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> string pool size and offset fields which are automatically
|
|
filled later.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveList``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Reserves space for an offset to the <paramref name="list"/> written later.
|
|
</summary>
|
|
<typeparam name="T">The type of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> elements.</typeparam>
|
|
<param name="list">The <see cref="T:System.Collections.Generic.IList`1"/> to save.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveDict``1(Syroot.NintenTools.Bfres.ResDict{``0})">
|
|
<summary>
|
|
Reserves space for an offset to the <paramref name="dict"/> written later.
|
|
</summary>
|
|
<typeparam name="T">The type of the <see cref="T:Syroot.NintenTools.Bfres.Core.IResData"/> element values.</typeparam>
|
|
<param name="dict">The <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> to save.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveCustom(System.Object,System.Action)">
|
|
<summary>
|
|
Reserves space for an offset to the <paramref name="data"/> written later with the
|
|
<paramref name="callback"/>.
|
|
</summary>
|
|
<param name="data">The data to save.</param>
|
|
<param name="callback">The <see cref="T:System.Action"/> to invoke to write the data.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveString(System.String,System.Text.Encoding)">
|
|
<summary>
|
|
Reserves space for an offset to the <paramref name="str"/> written later in the string pool with the
|
|
specified <paramref name="encoding"/>.
|
|
</summary>
|
|
<param name="str">The name to save.</param>
|
|
<param name="encoding">The <see cref="T:System.Text.Encoding"/> in which the name will be stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveStrings(System.Collections.Generic.IEnumerable{System.String},System.Text.Encoding)">
|
|
<summary>
|
|
Reserves space for offsets to the <paramref name="strings"/> written later in the string pool with the
|
|
specified <paramref name="encoding"/>
|
|
</summary>
|
|
<param name="strings">The names to save.</param>
|
|
<param name="encoding">The <see cref="T:System.Text.Encoding"/> in which the names will be stored.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.SaveBlock(System.Object,System.UInt32,System.Action)">
|
|
<summary>
|
|
Reserves space for an offset to the <paramref name="data"/> written later in the data block pool.
|
|
</summary>
|
|
<param name="data">The data to save.</param>
|
|
<param name="alignment">The alignment to seek to before invoking the callback.</param>
|
|
<param name="callback">The <see cref="T:System.Action"/> to invoke to write the data.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Core.ResFileSaver.WriteSignature(System.String)">
|
|
<summary>
|
|
Writes a BFRES signature consisting of 4 ASCII characters encoded as an <see cref="T:System.UInt32"/>.
|
|
</summary>
|
|
<param name="value">A valid signature.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Core.ResStringComparer">
|
|
<summary>
|
|
Represents a <see cref="P:System.StringComparer.Ordinal"/> sorting empty strings to the end of lists.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ExternalFile">
|
|
<summary>
|
|
Represents a file attachment to a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> which can be of arbitrary data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ExternalFile.Data">
|
|
<summary>
|
|
Gets or sets the raw data stored by the external file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ExternalFile.GetStream(System.Boolean)">
|
|
<summary>
|
|
Opens and returns a <see cref="T:System.IO.MemoryStream"/> on the raw <see cref="P:Syroot.NintenTools.Bfres.ExternalFile.Data"/> byte array, which optionally
|
|
can be written to.
|
|
</summary>
|
|
<param name="writable"><c>true</c> to allow write access to the raw data.</param>
|
|
<returns>The opened <see cref="T:System.IO.MemoryStream"/> instance.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.AlphaControl">
|
|
<summary>
|
|
Represents GX2 settings controlling additional alpha blending options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.AlphaControl.AlphaTestEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether alpha testing is enabled at all.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.AlphaControl.AlphaFunc">
|
|
<summary>
|
|
Gets or sets the comparison functions to use for alpha testing.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.BlendControl">
|
|
<summary>
|
|
Represents GX2 settings controlling color and alpha blending.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.ColorSourceBlend">
|
|
<summary>
|
|
Gets or sets the color source blend operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.ColorCombine">
|
|
<summary>
|
|
Gets or sets the color combine operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.ColorDestinationBlend">
|
|
<summary>
|
|
Gets or sets the color destination blend operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.AlphaSourceBlend">
|
|
<summary>
|
|
Gets or sets the alpha source blend operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.AlphaCombine">
|
|
<summary>
|
|
Gets or sets the alpha combine operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.AlphaDestinationBlend">
|
|
<summary>
|
|
Gets or sets the alpha destination blend operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.BlendControl.SeparateAlphaBlend">
|
|
<summary>
|
|
Gets or sets a value indicating whether alpha blending is separated from color blending.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.ColorControl">
|
|
<summary>
|
|
Represents GX2 settings controlling additional color blending options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.ColorControl.MultiWriteEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether multi writes are enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.ColorControl.ColorBufferEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the color buffer is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.ColorControl.BlendEnableMask">
|
|
<summary>
|
|
Gets or sets the bitmask used for blending.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.ColorControl.LogicOp">
|
|
<summary>
|
|
Gets or sets the ROP3 logic operation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.DepthControl">
|
|
<summary>
|
|
Represents GX2 settings controlling how depth and stencil buffer checks are performed and handled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.DepthTestEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether depth testing is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.DepthWriteEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether writing to the depth buffer is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.DepthFunc">
|
|
<summary>
|
|
Gets or sets the depth buffer comparison function, controlling whether a new fragment is allowed to
|
|
overwrite the old value in the depth buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.StencilTestEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether stencil testing is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.BackStencilEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether back-facing polygons are allowed to write to the stencil buffer or
|
|
not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.FrontStencilFunc">
|
|
<summary>
|
|
Gets or sets the front-facing polygon stencil comparison function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.FrontStencilFail">
|
|
<summary>
|
|
Gets or sets the stencil function configuring what to do with the existing stencil value when the stencil
|
|
test fails for front-facing polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.FrontStencilZPass">
|
|
<summary>
|
|
Gets or sets the stencil function taking effect when the stencil test passes with the depth buffer for
|
|
front-facing polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.FrontStencilZFail">
|
|
<summary>
|
|
Gets or sets the function taking effect when the stencil test fails with the depth buffer for front-facing
|
|
polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.BackStencilFunc">
|
|
<summary>
|
|
Gets or sets the back-facing polygon stencil comparison function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.BackStencilFail">
|
|
<summary>
|
|
Gets or sets the stencil function configuring what to do with the existing stencil value when the stencil
|
|
test fails for back-facing polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.BackStencilZPass">
|
|
<summary>
|
|
Gets or sets the stencil function taking effect when the stencil test passes with the depth buffer for
|
|
back-facing polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.DepthControl.BackStencilZFail">
|
|
<summary>
|
|
Gets or sets the function taking effect when the stencil test fails with the depth buffer for back-facing
|
|
polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2AAMode">
|
|
<summary>
|
|
Represents the AA modes (number of samples) for a surface.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat">
|
|
<summary>
|
|
Represents the format of a vertex attribute entry. Possible type conversions:
|
|
<para/>UNorm: attrib unsigned integer is converted to/from [0.0, 1.0] in shader.
|
|
<para/>UInt: attrib unsigned integer is copied to/from shader as unsigned int.
|
|
<para/>SNorm: attrib signed integer is converted to/from [-1.0, 1.0] in shader.
|
|
<para/>SInt: attrib signed integer is copied to/from shader as signed int.
|
|
<para/>Single: attrib single is copied to/from shader as Single.
|
|
<para/>UIntToSingle: attrib unsigned integer is converted Single in shader.
|
|
<para/>SIntToSingle: attrib signed integer is converted Single in shader.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2BlendCombine">
|
|
<summary>
|
|
Represents how the terms of the blend function are combined.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2BlendFunction">
|
|
<summary>
|
|
Represents the factors used in the blend function.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2CompareFunction">
|
|
<summary>
|
|
Represents compare functions used for depth and stencil tests.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2CompSel">
|
|
<summary>
|
|
Represents the source channels to map to a color channel in textures.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2FrontFaceMode">
|
|
<summary>
|
|
Represents the vertex order of front-facing polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2IndexFormat">
|
|
<summary>
|
|
Represents the type in which vertex indices are stored.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2LogicOp">
|
|
<summary>
|
|
Represents the logic op function to perform.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.Clear">
|
|
<summary>
|
|
Black
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.Set">
|
|
<summary>
|
|
White
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.Copy">
|
|
<summary>
|
|
Source (Default)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.InverseCopy">
|
|
<summary>
|
|
~Source
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.NoOperation">
|
|
<summary>
|
|
Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.Inverse">
|
|
<summary>
|
|
~Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.And">
|
|
<summary>
|
|
Source & Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.NAnd">
|
|
<summary>
|
|
~(Source & Destination)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.Or">
|
|
<summary>
|
|
Source | Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.NOr">
|
|
<summary>
|
|
~(Source | Destination)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.XOr">
|
|
<summary>
|
|
Source ^ Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.Equivalent">
|
|
<summary>
|
|
~(Source ^ Destination)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.ReverseAnd">
|
|
<summary>
|
|
Source & ~Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.InverseAnd">
|
|
<summary>
|
|
~Source & Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.ReverseOr">
|
|
<summary>
|
|
Source | ~Destination
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2LogicOp.InverseOr">
|
|
<summary>
|
|
~Source | Destination
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2PolygonMode">
|
|
<summary>
|
|
Represents the base primitive used to draw each side of the polygon when dual-sided polygon mode is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType">
|
|
<summary>
|
|
Represents the type of primitives to draw.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.Points">
|
|
<summary>
|
|
Requires at least 1 element and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.Lines">
|
|
<summary>
|
|
Requires at least 2 elements and 2 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.LineStrip">
|
|
<summary>
|
|
Requires at least 2 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.Triangles">
|
|
<summary>
|
|
Requires at least 3 elements and 3 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TriangleFan">
|
|
<summary>
|
|
Requires at least 3 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TriangleStrip">
|
|
<summary>
|
|
Requires at least 3 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.LinesAdjacency">
|
|
<summary>
|
|
Requires at least 4 elements and 4 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.LineStripAdjacency">
|
|
<summary>
|
|
Requires at least 4 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TrianglesAdjacency">
|
|
<summary>
|
|
Requires at least 6 elements and 6 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TriangleStripAdjacency">
|
|
<summary>
|
|
Requires at least 6 elements and 2 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.Rects">
|
|
<summary>
|
|
Requires at least 3 elements and 3 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.LineLoop">
|
|
<summary>
|
|
Requires at least 2 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.Quads">
|
|
<summary>
|
|
Requires at least 4 elements and 4 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.QuadStrip">
|
|
<summary>
|
|
Requires at least 4 elements and 2 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TessellateLines">
|
|
<summary>
|
|
Requires at least 2 elements and 2 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TessellateLineStrip">
|
|
<summary>
|
|
Requires at least 2 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TessellateTriangles">
|
|
<summary>
|
|
Requires at least 3 elements and 3 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TessellateTriangleStrip">
|
|
<summary>
|
|
Requires at least 3 elements and 1 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TessellateQuads">
|
|
<summary>
|
|
Requires at least 4 elements and 4 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType.TessellateQuadStrip">
|
|
<summary>
|
|
Requires at least 4 elements and 2 more to draw another primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2StencilFunction">
|
|
<summary>
|
|
Represents the stencil function to be performed if stencil tests pass.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2SurfaceDim">
|
|
<summary>
|
|
Represents shapes of a given surface or texture.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2SurfaceFormat">
|
|
<summary>
|
|
Represents desired texture, color-buffer, depth-buffer, or scan-buffer formats.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2SurfaceUse">
|
|
<summary>
|
|
Represents Indicates how a given surface may be used. A final TV render target is one that will be copied to a
|
|
TV scan buffer. It needs to be designated to handle certain display corner cases (when a HD surface must be
|
|
scaled down to display in NTSC/PAL).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TexAnisoRatio">
|
|
<summary>
|
|
Represents maximum desired anisotropic filter ratios. Higher ratios give better image quality, but slower
|
|
performance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TexBorderType">
|
|
<summary>
|
|
Represents type of border color to use.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TexClamp">
|
|
<summary>
|
|
Represents how to treat texture coordinates outside of the normalized coordinate texture range.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TexMipFilterType">
|
|
<summary>
|
|
Represents desired texture filter options between mip levels.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TexXYFilterType">
|
|
<summary>
|
|
Represents desired texture filter options within a plane.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TexZFilterType">
|
|
<summary>
|
|
Represents desired texture filter options between Z planes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.GX2TileMode">
|
|
<summary>
|
|
Represents the desired tiling modes for a surface.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.PolygonControl">
|
|
<summary>
|
|
Represents GX2 polygon drawing settings controlling if and how triangles are rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.CullFront">
|
|
<summary>
|
|
Gets or sets a value indicating whether front-facing polygons are culled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.CullBack">
|
|
<summary>
|
|
Gets or sets a value indicating whether back-facing polygons are culled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.FrontFace">
|
|
<summary>
|
|
Gets or sets the order in which vertices have to form the triangle to be handled as a front- rather than
|
|
back-face.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.PolygonModeEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether polygons are drawn at all.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.PolygonModeFront">
|
|
<summary>
|
|
Gets or sets how front facing polygons are drawn.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.PolygonModeBack">
|
|
<summary>
|
|
Gets or sets how back facing polygons are drawn.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.PolygonOffsetFrontEnabled">
|
|
<summary>
|
|
Gets or sets whether front-facing polygons are drawn offset (useful for decals to combat Z fighting).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.PolygonOffsetBackEnabled">
|
|
<summary>
|
|
Gets or sets whether back-facing polygons are drawn offset (useful for decals to combat Z fighting).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.PolygonControl.PolygonLineOffsetEnabled">
|
|
<summary>
|
|
Gets or sets whether lines are drawn offset (useful for decals to combat Z fighting).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.GX2.TexSampler">
|
|
<summary>
|
|
Represents a GX2 texture sampler controlling how a texture is samples and drawn onto a surface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.GX2.TexSampler.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.GX2.TexSampler"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.ClampX">
|
|
<summary>
|
|
Gets or sets the texture repetition mode on the X axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.ClampY">
|
|
<summary>
|
|
Gets or sets the texture repetition mode on the Y axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.ClampZ">
|
|
<summary>
|
|
Gets or sets the texture repetition mode on the Z axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.MagFilter">
|
|
<summary>
|
|
Gets or sets the texture filtering on the X and Y axes when the texture is drawn larger than the actual
|
|
texture's resolution.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.MinFilter">
|
|
<summary>
|
|
Gets or sets the texture filtering on the X and Y axes when the texture is drawn smaller than the actual
|
|
texture's resolution.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.ZFilter">
|
|
<summary>
|
|
Gets or sets the texture filtering on the Z axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.MipFilter">
|
|
<summary>
|
|
Gets or sets the texture filtering for mipmaps.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.MaxAnisotropicRatio">
|
|
<summary>
|
|
Gets or sets the maximum anisotropic filtering level to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.BorderType">
|
|
<summary>
|
|
Gets or sets what color to draw at places not reached by a texture if the clamp mode does not repeat it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.DepthCompareFunc">
|
|
<summary>
|
|
Gets or sets the depth comparison function.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.MinLod">
|
|
<summary>
|
|
Gets or sets the minimum LoD level.
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.MaxLod">
|
|
<summary>
|
|
Gets or sets the maximum LoD level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.LodBias">
|
|
<summary>
|
|
Gets or sets the LoD bias.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.GX2.TexSampler.DepthCompareEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether depth comparison is enabled (never set for a real console).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper">
|
|
<summary>
|
|
Represents a helper class for working with <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.#ctor(Syroot.NintenTools.Bfres.VertexBuffer,System.Nullable{Syroot.BinaryData.ByteOrder})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper"/> class with data read from the given
|
|
<paramref name="vertexBuffer"/>. The data is available in the <paramref name="byteOrder"/>, which defaults
|
|
to system byte order.
|
|
</summary>
|
|
<param name="vertexBuffer">The <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/> to initially read data from.</param>
|
|
<param name="byteOrder">The <see cref="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.ByteOrder"/> in which vertex data is available. <c>null</c> to use
|
|
system byte order.</param>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.ByteOrder">
|
|
<summary>
|
|
Gets or sets the <see cref="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.ByteOrder"/> in which vertex data will be stored when calling
|
|
<see cref="M:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.ToVertexBuffer"/>. This should be the same as the remainder of the <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> in
|
|
which it will be stored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.VertexSkinCount">
|
|
<summary>
|
|
Gets or sets the number of bones influencing the vertices stored in the buffer. 0 influences equal
|
|
rigidbodies (no skinning), 1 equal rigid skinning and 2 or more smooth skinning.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.Attributes">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instances which store the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instance at the given <paramref name="index"/>.
|
|
</summary>
|
|
<param name="index">The index of the <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instance.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instance at the given index.</returns>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.Item(System.String)">
|
|
<summary>
|
|
Gets or sets the first <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instance with the given
|
|
<paramref name="attribName"/>.
|
|
</summary>
|
|
<param name="attribName">The name of the <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instance.</param>
|
|
<returns>The <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/> instance with the given name.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper.ToVertexBuffer">
|
|
<summary>
|
|
Returns a <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/> instance out of the stored helper data.
|
|
</summary>
|
|
<returns>A new <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/>.</returns>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib">
|
|
<summary>
|
|
Represents an attribute and the data it stores in a <see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelper"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib.Name">
|
|
<summary>
|
|
The name of the attribute, typically used to determine the use of the data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib.Format">
|
|
<summary>
|
|
The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> into which data will be converted upon creating a
|
|
<see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib.Data">
|
|
<summary>
|
|
The data stored for this attribute. Has to be of the same length as every other
|
|
<see cref="T:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib"/>. Depending on <see cref="F:Syroot.NintenTools.Bfres.Helpers.VertexBufferHelperAttrib.Format"/>, not every component of the
|
|
<see cref="T:Syroot.Maths.Vector4F"/> elements is used.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Material">
|
|
<summary>
|
|
Represents an FMAT subsection of a <see cref="T:Syroot.NintenTools.Bfres.Model"/> subfile, storing information on with which textures and
|
|
how technically a surface is drawn.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Material.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Material"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.Flags">
|
|
<summary>
|
|
Gets or sets flags specifying how a <see cref="T:Syroot.NintenTools.Bfres.Material"/> is rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.Visible">
|
|
<summary>
|
|
Gets or sets the visible flag to display the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.TextureRefs">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.TextureRef"/> instances referencing the <see cref="T:Syroot.NintenTools.Bfres.Texture"/> instances
|
|
required to draw the material.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.Samplers">
|
|
<summary>
|
|
Gets or sets a dictionary of <see cref="T:Syroot.NintenTools.Bfres.Sampler"/> instances which configure how to draw
|
|
<see cref="T:Syroot.NintenTools.Bfres.Texture"/> instances referenced by the <see cref="P:Syroot.NintenTools.Bfres.Material.TextureRefs"/> list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.ShaderParamData">
|
|
<summary>
|
|
Gets or sets the raw data block which stores <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.Material.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Material.VolatileFlags">
|
|
<summary>
|
|
Gets or sets a set of bits determining whether <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> instances are volatile.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.MaterialFlags">
|
|
<summary>
|
|
Represents general flags specifying how a <see cref="T:Syroot.NintenTools.Bfres.Material"/> is rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.MaterialFlags.None">
|
|
<summary>
|
|
The material is not rendered at all.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.MaterialFlags.Visible">
|
|
<summary>
|
|
The material is rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.RenderInfo">
|
|
<summary>
|
|
Represents a render info in a FMAT section storing uniform parameters required to render the
|
|
<see cref="T:Syroot.NintenTools.Bfres.UserData"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.RenderInfo"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderInfo.Type">
|
|
<summary>
|
|
Gets the <see cref="T:Syroot.NintenTools.Bfres.RenderInfoType"/> determining the data type of the stored value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderInfo.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.GetValueInt32s">
|
|
<summary>
|
|
Gets the stored value as an <see cref="T:System.Int32"/> array. Only valid if <see cref="P:Syroot.NintenTools.Bfres.RenderInfo.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.Int32"/>.
|
|
</summary>
|
|
<returns>The stored value as an <see cref="T:System.Int32"/> array.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.GetValueSingles">
|
|
<summary>
|
|
Gets the stored value as a <see cref="T:System.Single"/> array. Only valid if <see cref="P:Syroot.NintenTools.Bfres.RenderInfo.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.Single"/>.
|
|
</summary>
|
|
<returns>The stored value as a <see cref="T:System.Single"/> array.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.GetValueStrings">
|
|
<summary>
|
|
Gets the stored value as a <see cref="T:System.String"/> array. Only valid if <see cref="P:Syroot.NintenTools.Bfres.RenderInfo.Type"/> is
|
|
<see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.String"/>.
|
|
</summary>
|
|
<returns>The stored value as a <see cref="T:System.String"/> array.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.SetValue(System.Int32[])">
|
|
<summary>
|
|
Sets the stored value as an <see cref="T:System.Int32"/> array and sets <see cref="P:Syroot.NintenTools.Bfres.RenderInfo.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.Int32"/>.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Int32"/> array to set as the value.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.SetValue(System.Single[])">
|
|
<summary>
|
|
Sets the stored value as a <see cref="T:System.Single"/> array and sets <see cref="P:Syroot.NintenTools.Bfres.RenderInfo.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.Single"/>.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.Single"/> array to set as the value.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderInfo.SetValue(System.String[])">
|
|
<summary>
|
|
Sets the stored value as a <see cref="T:System.String"/> array and sets <see cref="P:Syroot.NintenTools.Bfres.RenderInfo.Type"/> to
|
|
<see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.String"/>.
|
|
</summary>
|
|
<param name="value">The <see cref="T:System.String"/> array to set as the value.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.RenderInfoType">
|
|
<summary>
|
|
Represents the data type of elements of the <see cref="T:Syroot.NintenTools.Bfres.RenderInfo"/> value array.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.RenderInfoType.Int32">
|
|
<summary>
|
|
The elements are <see cref="T:System.Int32"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.RenderInfoType.Single">
|
|
<summary>
|
|
The elements are <see cref="T:System.Single"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.RenderInfoType.String">
|
|
<summary>
|
|
The elements are <see cref="F:Syroot.NintenTools.Bfres.RenderInfoType.String"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.RenderState">
|
|
<summary>
|
|
Represents GX2 GPU configuration to determine how polygons are rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.RenderState.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.RenderState"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.PolygonControl">
|
|
<summary>
|
|
Gets or sets GX2 polygon drawing settings controlling if and how triangles are rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.DepthControl">
|
|
<summary>
|
|
Gets or sets GX2 settings controlling how depth and stencil buffer checks are performed and handled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.AlphaControl">
|
|
<summary>
|
|
Gets or sets GX2 settings controlling additional alpha blending options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.AlphaRefValue">
|
|
<summary>
|
|
Gets or sets the reference value used for alpha testing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.ColorControl">
|
|
<summary>
|
|
Gets or sets GX2 settings controlling additional color blending options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.BlendTarget">
|
|
<summary>
|
|
Gets or sets the blend target index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.BlendControl">
|
|
<summary>
|
|
Gets or sets GX2 settings controlling color and alpha blending.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.RenderState.BlendColor">
|
|
<summary>
|
|
Gets or sets the blend color to perform blending with.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Sampler">
|
|
<summary>
|
|
Represents a <see cref="T:Syroot.NintenTools.Bfres.Texture"/> sampler in a <see cref="T:Syroot.NintenTools.Bfres.UserData"/> section, storing configuration on how to
|
|
draw and interpolate textures.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Sampler.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Sampler"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Sampler.TexSampler">
|
|
<summary>
|
|
Gets or sets the internal representation of the sampler configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Sampler.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ShaderAssign.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ShaderAssign"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShaderParam">
|
|
<summary>
|
|
Represents a parameter value in a <see cref="T:Syroot.NintenTools.Bfres.UserData"/> section, passing data to shader variables.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ShaderParam.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParam.Type">
|
|
<summary>
|
|
Gets or sets the type of the value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParam.DataOffset">
|
|
<summary>
|
|
Gets the offset in the <see cref="P:Syroot.NintenTools.Bfres.Material.ShaderParamData"/> byte array in bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParam.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParam.DataSize">
|
|
<summary>
|
|
Gets the size of the value in bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShaderParamType">
|
|
<summary>
|
|
Represents the data types in which <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> instances can store their value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Bool">
|
|
<summary>
|
|
The value is a single <see cref="T:System.Boolean"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Bool2">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector2Bool"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Bool3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector3Bool"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Bool4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector4Bool"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Int">
|
|
<summary>
|
|
The value is a single <see cref="T:System.Int32"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Int2">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector2"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Int3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector3"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Int4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector4"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.UInt">
|
|
<summary>
|
|
The value is a single <see cref="T:System.UInt32"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.UInt2">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector2U"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.UInt3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector3U"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.UInt4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector4U"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float">
|
|
<summary>
|
|
The value is a single <see cref="T:System.Single"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float2">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector2F"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector3F"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Vector4F"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Reserved2">
|
|
<summary>
|
|
An invalid type for <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> values, only used for internal computations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float2x2">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix2"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float2x3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix2x3"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float2x4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix2x4"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Reserved3">
|
|
<summary>
|
|
An invalid type for <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> values, only used for internal computations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float3x2">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix3x2"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float3x3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix3"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float3x4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix3x4"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Reserved4">
|
|
<summary>
|
|
An invalid type for <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> values, only used for internal computations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float4x2">
|
|
<summary>
|
|
The value is a <see cref="T:System.Single"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float4x3">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix4x3"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Float4x4">
|
|
<summary>
|
|
The value is a <see cref="T:Syroot.Maths.Matrix4"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Srt2D">
|
|
<summary>
|
|
The value is a <see cref="F:Syroot.NintenTools.Bfres.ShaderParamType.Srt2D"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.Srt3D">
|
|
<summary>
|
|
The value is a <see cref="F:Syroot.NintenTools.Bfres.ShaderParamType.Srt3D"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.TexSrt">
|
|
<summary>
|
|
The value is a <see cref="F:Syroot.NintenTools.Bfres.ShaderParamType.TexSrt"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamType.TexSrtEx">
|
|
<summary>
|
|
The value is a <see cref="F:Syroot.NintenTools.Bfres.ShaderParamType.TexSrtEx"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Model">
|
|
<summary>
|
|
Represents an FMDL subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing model vertex data, skeletons and used materials.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Model.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Model"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.Skeleton">
|
|
<summary>
|
|
Gets the <see cref="P:Syroot.NintenTools.Bfres.Model.Skeleton"/> instance to deform the model with animations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.VertexBuffers">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/> instances storing the vertex data used by the
|
|
<see cref="P:Syroot.NintenTools.Bfres.Model.Shapes"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.Shapes">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Shape"/> instances forming the surface of the model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.Materials">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Material"/> instance applied on the <see cref="P:Syroot.NintenTools.Bfres.Model.Shapes"/> to color their surface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.Model.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Model.TotalVertexCount">
|
|
<summary>
|
|
Gets the total number of vertices to process when drawing this model.
|
|
</summary>
|
|
<remarks>This excludes vertices which are not processed by any shader. However, the exact value does not
|
|
seem to matter, so the total count of all vertices is taken to keep things trivial for now.</remarks>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Bounding">
|
|
<summary>
|
|
Represents a spatial bounding box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Bounding.Center">
|
|
<summary>
|
|
The center point of the bounding box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.Bounding.Extent">
|
|
<summary>
|
|
The extent from the center point to the furthest point.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoundingNode">
|
|
<summary>
|
|
Represents a node in a <see cref="T:Syroot.NintenTools.Bfres.SubMesh"/> bounding tree to determine when to show which sub mesh of a
|
|
<see cref="T:Syroot.NintenTools.Bfres.Mesh"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Mesh">
|
|
<summary>
|
|
Represents the surface net of a <see cref="T:Syroot.NintenTools.Bfres.Shape"/> section, storing information on which
|
|
index <see cref="T:Syroot.NintenTools.Bfres.Buffer"/> to use for referencing vertices of the shape, mostly used for different levels of
|
|
detail (LoD) models.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Mesh.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Mesh"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Mesh.PrimitiveType">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2PrimitiveType"/> which determines how indices are used to form polygons.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Mesh.IndexFormat">
|
|
<summary>
|
|
Gets the <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2IndexFormat"/> determining the data type of the indices in the
|
|
<see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Mesh.IndexCount">
|
|
<summary>
|
|
Gets the number of indices stored in the <see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Mesh.SubMeshes">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.SubMesh"/> instances which split up a mesh into parts which can be
|
|
hidden if they are not visible to optimize rendering performance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Buffer"/> storing the index data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Mesh.FirstVertex">
|
|
<summary>
|
|
Gets or sets the offset to the first vertex element of a <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/> to reference by indices.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Mesh.GetIndices">
|
|
<summary>
|
|
Returns the indices stored in the <see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer"/> as <see cref="T:System.UInt32"/> instances.
|
|
</summary>
|
|
<returns>The indices stored in the <see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer"/>.</returns>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Mesh.SetIndices(System.Collections.Generic.IList{System.UInt32},System.Nullable{Syroot.NintenTools.Bfres.GX2.GX2IndexFormat})">
|
|
<summary>
|
|
Stores the given <paramref name="indices"/> in the <see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer"/> in the provided
|
|
<paramref name="format"/>, or the current <see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexFormat"/> if none was specified.
|
|
</summary>
|
|
<param name="indices">The indices to store in the <see cref="P:Syroot.NintenTools.Bfres.Mesh.IndexBuffer"/>.</param>
|
|
<param name="format">The <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2IndexFormat"/> to use or <c>null</c> to use the current format.
|
|
</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Shape">
|
|
<summary>
|
|
Represents an FSHP section in a <see cref="T:Syroot.NintenTools.Bfres.Model"/> subfile.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Shape.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Shape"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.Flags">
|
|
<summary>
|
|
Gets or sets flags determining which data is available for this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.MaterialIndex">
|
|
<summary>
|
|
Gets or sets the index of the material to apply to the shapes surface in the owning
|
|
<see cref="P:Syroot.NintenTools.Bfres.Model.Materials"/> list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.BoneIndex">
|
|
<summary>
|
|
Gets or sets the index of the <see cref="T:Syroot.NintenTools.Bfres.Bone"/> to which this instance is directly attached to. The bone
|
|
must be part of the skeleton referenced by the owning <see cref="P:Syroot.NintenTools.Bfres.Model.Skeleton"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.VertexBufferIndex">
|
|
<summary>
|
|
Gets or sets the index of the <see cref="P:Syroot.NintenTools.Bfres.Shape.VertexBuffer"/> in the owning <see cref="P:Syroot.NintenTools.Bfres.Model.VertexBuffers"/>
|
|
list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.RadiusArray">
|
|
<summary>
|
|
Gets or sets the bounding radius/radii spanning the shape. BOTW uses multiple per LOD mesh.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.VertexSkinCount">
|
|
<summary>
|
|
Gets or sets the number of bones influencing the vertices stored in this buffer. 0 influences equal
|
|
rigidbodies (no skinning), 1 equal rigid skinning and 2 or more smooth skinning.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.TargetAttribCount">
|
|
<summary>
|
|
Gets or sets a value with unknown purpose.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.Meshes">
|
|
<summary>
|
|
Gets or sets the list of <see cref="P:Syroot.NintenTools.Bfres.Shape.Meshes"/> which are used to represent different level of details of the
|
|
shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.SubMeshBoundingNodes">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.BoundingNode"/> instances forming the bounding tree with which parts of a mesh
|
|
are culled when not visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Shape.VertexBuffer">
|
|
<summary>
|
|
Gets or sets the <see cref="P:Syroot.NintenTools.Bfres.Shape.VertexBuffer"/> instance storing the data which forms the shape's surface. Saved
|
|
depending on <see cref="P:Syroot.NintenTools.Bfres.Shape.VertexBufferIndex"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShapeFlags">
|
|
<summary>
|
|
Represents flags determining which data is available for <see cref="T:Syroot.NintenTools.Bfres.Shape"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShapeFlags.HasVertexBuffer">
|
|
<summary>
|
|
The <see cref="T:Syroot.NintenTools.Bfres.Shape"/> instance references a <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShapeFlags.SubMeshBoundaryConsistent">
|
|
<summary>
|
|
The boundings in all submeshes are consistent.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SubMesh">
|
|
<summary>
|
|
Represents a subarray of a <see cref="T:Syroot.NintenTools.Bfres.Mesh"/> section, storing a slice of indices to draw from the index buffer
|
|
referenced in the mesh, mostly used for hiding parts of a model when not visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SubMesh.Offset">
|
|
<summary>
|
|
Gets the offset into the index buffer in bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SubMesh.Count">
|
|
<summary>
|
|
Gets the number of indices to reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Bone">
|
|
<summary>
|
|
Represents a single bone in a <see cref="T:Syroot.NintenTools.Bfres.Skeleton"/> section, storing its initial transform and transformation
|
|
effects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Bone.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Bone"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.ParentIndex">
|
|
<summary>
|
|
Gets or sets the index of the parent <see cref="T:Syroot.NintenTools.Bfres.Bone"/> this instance is a child of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.SmoothMatrixIndex">
|
|
<summary>
|
|
Gets or sets the index of a matrix used for smooth skinning.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.RigidMatrixIndex">
|
|
<summary>
|
|
Gets or sets the index of a matrix used for rigid skinning.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling bone behavior.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.FlagsRotation">
|
|
<summary>
|
|
Gets or sets the rotation method used to store bone rotations in <see cref="P:Syroot.NintenTools.Bfres.Bone.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.FlagsBillboard">
|
|
<summary>
|
|
Gets or sets the billboard transformation applied to the bone.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.Scale">
|
|
<summary>
|
|
Gets or sets the spatial scale of the bone.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.Rotation">
|
|
<summary>
|
|
Gets or sets the spatial rotation of the bone. If <see cref="F:Syroot.NintenTools.Bfres.BoneFlagsRotation.EulerXYZ"/> is used, the
|
|
fourth component is always <c>1.0f</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.Position">
|
|
<summary>
|
|
Gets or sets the spatial position of the bone.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.Bone.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Bone.InverseMatrix">
|
|
<summary>
|
|
Gets or sets the inverse matrix (Only used in bfres verson v3.3.X.X and below)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneFlags">
|
|
<summary>
|
|
Represents flags controlling bone behavior.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlags.Visible">
|
|
<summary>
|
|
Set when the bone is visible.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneFlagsRotation">
|
|
<summary>
|
|
Represents the rotation method used to store bone rotations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsRotation.Quaternion">
|
|
<summary>
|
|
A quaternion represents the rotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsRotation.EulerXYZ">
|
|
<summary>
|
|
A <see cref="T:Syroot.Maths.Vector3F"/> represents the Euler rotation in XYZ order.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneFlagsBillboard">
|
|
<summary>
|
|
Represents the possible transformations for bones to handle them as billboards.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.None">
|
|
<summary>
|
|
No transformation is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.Child">
|
|
<summary>
|
|
Transforms of the child are applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.WorldViewVector">
|
|
<summary>
|
|
Transforms the Z axis parallel to the camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.WorldViewPoint">
|
|
<summary>
|
|
Transforms the Z axis parallel to the direction of the camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.ScreenViewVector">
|
|
<summary>
|
|
Transforms the Y axis parallel to the camera up vector, and the Z parallel to the camera up-vector.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.ScreenViewPoint">
|
|
<summary>
|
|
Transforms the Y axis parallel to the camera up vector, and the Z axis parallel to the direction of the
|
|
camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.YAxisViewVector">
|
|
<summary>
|
|
Transforms the Z axis parallel to the camera by rotating only the Y axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneFlagsBillboard.YAxisViewPoint">
|
|
<summary>
|
|
Transforms the Z axis parallel to the direction of the camera by rotating only the Y axis.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Skeleton">
|
|
<summary>
|
|
Represents an FSKL section in a <see cref="T:Syroot.NintenTools.Bfres.Model"/> subfile, storing armature data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Skeleton.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Skeleton"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Skeleton.FlagsRotation">
|
|
<summary>
|
|
Gets or sets the rotation method used to store bone rotations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Skeleton.Bones">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.Bone"/> instances forming the skeleton.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SkeletonFlagsRotation">
|
|
<summary>
|
|
Represents the rotation method used to store bone rotations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletonFlagsRotation.Quaternion">
|
|
<summary>
|
|
A quaternion represents the rotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletonFlagsRotation.EulerXYZ">
|
|
<summary>
|
|
A <see cref="T:Syroot.Maths.Vector3F"/> represents the Euler rotation in XYZ order.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.VertexAttrib">
|
|
<summary>
|
|
Represents an attribute of a <see cref="T:Syroot.NintenTools.Bfres.VertexBuffer"/> describing the data format, type and layout of a
|
|
specific data subset in the buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.VertexAttrib.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.VertexAttrib"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexAttrib.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexAttrib.BufferIndex">
|
|
<summary>
|
|
Gets or sets the index of the buffer storing the data in the <see cref="P:Syroot.NintenTools.Bfres.VertexBuffer.Buffers"/> list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexAttrib.Offset">
|
|
<summary>
|
|
Gets or sets the offset in bytes to the attribute in each vertex.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexAttrib.Format">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.GX2.GX2AttribFormat"/> determining the type in which attribute data is available.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.VertexBuffer">
|
|
<summary>
|
|
Represents a data buffer holding vertices for a <see cref="T:Syroot.NintenTools.Bfres.Model"/> subfile.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.VertexBuffer.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Mesh"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexBuffer.VertexSkinCount">
|
|
<summary>
|
|
Gets or sets the number of bones influencing the vertices stored in this buffer. 0 influences equal
|
|
rigidbodies (no skinning), 1 equal rigid skinning and 2 or more smooth skinning.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexBuffer.VertexCount">
|
|
<summary>
|
|
Gets the number of vertices stored by the <see cref="P:Syroot.NintenTools.Bfres.VertexBuffer.Buffers"/>. It is calculated from the size of the first
|
|
<see cref="T:Syroot.NintenTools.Bfres.Buffer"/> in bytes divided by the <see cref="P:Syroot.NintenTools.Bfres.Buffer.Stride"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexBuffer.Attributes">
|
|
<summary>
|
|
Gets or sets the dictionary of <see cref="T:Syroot.NintenTools.Bfres.VertexAttrib"/> instances describing how to interprete data in the
|
|
<see cref="P:Syroot.NintenTools.Bfres.VertexBuffer.Buffers"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexBuffer.Buffers">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.Buffer"/> instances storing raw unformatted vertex data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ResException">
|
|
<summary>
|
|
Represents an exception raised when handling <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResException"/> class with a specified error
|
|
<paramref name="message"/>.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResException.#ctor(System.String,System.Object[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResException"/> class with a specified error message created
|
|
from the given <paramref name="format"/> and <paramref name="args"/>.
|
|
</summary>
|
|
<param name="format">The format of the error message.</param>
|
|
<param name="args">The parameters to format the error message with.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ResFile">
|
|
<summary>
|
|
Represents a NintendoWare for Cafe (NW4F) graphics data archive file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResFile.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResFile.#ctor(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> class from the given <paramref name="stream"/> which
|
|
is optionally left open.
|
|
</summary>
|
|
<param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
|
|
<param name="leaveOpen"><c>true</c> to leave the stream open after reading, otherwise <c>false</c>.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResFile.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ResFile"/> class from the file with the given
|
|
<paramref name="fileName"/>.
|
|
</summary>
|
|
<param name="fileName">The name of the file to load the data from.</param>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.Alignment">
|
|
<summary>
|
|
Gets or sets the alignment to use for raw data blocks in the file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.Name">
|
|
<summary>
|
|
Gets or sets a name describing the contents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.Version">
|
|
<summary>
|
|
Gets or sets the revision of the BFRES structure formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.VersioFull">
|
|
<summary>
|
|
Gets or sets the major revision of the BFRES structure formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.VersionMajor">
|
|
<summary>
|
|
Gets or sets the major revision of the BFRES structure formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.VersionMajor2">
|
|
<summary>
|
|
Gets or sets the second major revision of the BFRES structure formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.VersionMinor">
|
|
<summary>
|
|
Gets or sets the minor revision of the BFRES structure formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.VersionMinor2">
|
|
<summary>
|
|
Gets or sets the second minor revision of the BFRES structure formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.ByteOrder">
|
|
<summary>
|
|
Gets the byte order in which data is stored. Must be the endianness of the target platform.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.Models">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.Model"/> (FMDL) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.Textures">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.Texture"/> (FTEX) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.SkeletalAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.SkeletalAnim"/> (FSKA) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.ShaderParamAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.ShaderParamAnim"/> (FSHU) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.ColorAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.ShaderParamAnim"/> (FSHU) instances for color animations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.TexSrtAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.ShaderParamAnim"/> (FSHU) instances for texture SRT animations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.TexPatternAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.TexPatternAnim"/> (FTXP) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.BoneVisibilityAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.VisibilityAnim"/> (FVIS) instances for bone visibility animations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.MatVisibilityAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.VisibilityAnim"/> (FVIS) instances for material visibility animations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.ShapeAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.ShapeAnim"/> (FSHA) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.SceneAnims">
|
|
<summary>
|
|
Gets or sets the stored <see cref="T:Syroot.NintenTools.Bfres.SceneAnim"/> (FSCN) instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ResFile.ExternalFiles">
|
|
<summary>
|
|
Gets or sets attached <see cref="T:Syroot.NintenTools.Bfres.ExternalFile"/> instances. The key of the dictionary typically represents
|
|
the name of the file they were originally created from.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResFile.Save(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Saves the contents in the given <paramref name="stream"/> and optionally leaves it open
|
|
</summary>
|
|
<param name="stream">The <see cref="T:System.IO.Stream"/> to save the contents into.</param>
|
|
<param name="leaveOpen"><c>true</c> to leave the stream open after writing, otherwise <c>false</c>.</param>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ResFile.Save(System.String)">
|
|
<summary>
|
|
Saves the contents in the file with the given <paramref name="fileName"/>.
|
|
</summary>
|
|
<param name="fileName">The name of the file to save the contents into.</param>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.CameraAnim">
|
|
<summary>
|
|
Represents an FCAM section in a <see cref="T:Syroot.NintenTools.Bfres.SceneAnim"/> subfile, storing animations controlling camera settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.CameraAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.CameraAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="P:Syroot.NintenTools.Bfres.CameraAnim.Curves"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.BaseData">
|
|
<summary>
|
|
Gets the <see cref="T:Syroot.NintenTools.Bfres.CameraAnimData"/> instance storing initial camera parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.CameraAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.CameraAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.CameraAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimFlags.EulerZXY">
|
|
<summary>
|
|
The rotation mode stores ZXY angles rather than look-at points in combination with a twist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimFlags.Perspective">
|
|
<summary>
|
|
The projection mode is perspective rather than ortographic.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.CameraAnimData">
|
|
<summary>
|
|
Represents the animatable data of scene cameras.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.ClipNear">
|
|
<summary>
|
|
The near clipping plane distance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.ClipFar">
|
|
<summary>
|
|
The far clipping plane distance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.AspectRatio">
|
|
<summary>
|
|
The aspect ratio of the projected image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.FieldOfView">
|
|
<summary>
|
|
The field of view of the projected image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.Position">
|
|
<summary>
|
|
The spatial position of the camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.Rotation">
|
|
<summary>
|
|
The spatial rotation of the camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimData.Twist">
|
|
<summary>
|
|
The spatial twist of the camera.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.CameraAnimDataOffset">
|
|
<summary>
|
|
Gets the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.AnimDataOffset"/> for <see cref="T:Syroot.NintenTools.Bfres.CameraAnimData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.ClipNear">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.ClipNear"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.ClipFar">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.ClipFar"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.AspectRatio">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.AspectRatio"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.FieldOFView">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.FieldOfView"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.PositionX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Position"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.PositionY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Position"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.PositionZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Position"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.RotationX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.RotationY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.RotationZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.CameraAnimDataOffset.Twist">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.CameraAnimData.Twist"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.FogAnim">
|
|
<summary>
|
|
Represents an FCAM section in a <see cref="T:Syroot.NintenTools.Bfres.SceneAnim"/> subfile, storing animations controlling fog settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.FogAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.FogAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.DistanceAttnFuncIndex">
|
|
<summary>
|
|
Gets or sets the index of the distance attenuation function to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="P:Syroot.NintenTools.Bfres.FogAnim.Curves"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.DistanceAttnFuncName">
|
|
<summary>
|
|
Gets or sets the name of the distance attenuation function to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.BaseData">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.FogAnimData"/> instance storing initial fog parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.FogAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.FogAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.FogAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.FogAnimData">
|
|
<summary>
|
|
Represents the animatable data of scene fog.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimData.DistanceAttn">
|
|
<summary>
|
|
The distance attenuation of the fog depth.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimData.Color">
|
|
<summary>
|
|
The color of the fog.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.FogAnimDataOffset">
|
|
<summary>
|
|
Gets the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.AnimDataOffset"/> for <see cref="T:Syroot.NintenTools.Bfres.FogAnimData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimDataOffset.DistanceAttnX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.FogAnimData.DistanceAttn"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimDataOffset.DistanceAttnY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.FogAnimData.DistanceAttn"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimDataOffset.ColorR">
|
|
<summary>
|
|
Animates the X (red) component of <see cref="F:Syroot.NintenTools.Bfres.FogAnimData.Color"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimDataOffset.ColorG">
|
|
<summary>
|
|
Animates the Y (green) component of <see cref="F:Syroot.NintenTools.Bfres.FogAnimData.Color"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.FogAnimDataOffset.ColorB">
|
|
<summary>
|
|
Animates the Z (blue) component of <see cref="F:Syroot.NintenTools.Bfres.FogAnimData.Color"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.LightAnim">
|
|
<summary>
|
|
Represents an FLIT section in a <see cref="T:Syroot.NintenTools.Bfres.SceneAnim"/> subfile, storing animations controlling light settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.LightAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.LightAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.AnimatedFields">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.LightTypeIndex">
|
|
<summary>
|
|
Gets or sets the index of the light type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.DistanceAttnFuncIndex">
|
|
<summary>
|
|
Gets or sets the index of the distance attenuation function to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.AngleAttnFuncIndex">
|
|
<summary>
|
|
Gets or sets the index of the angle attenuation function to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="P:Syroot.NintenTools.Bfres.LightAnim.Curves"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.LightTypeName">
|
|
<summary>
|
|
Gets or sets the name of the light type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.DistanceAttnFuncName">
|
|
<summary>
|
|
Gets or sets the name of the distance attenuation function to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.AngleAttnFuncName">
|
|
<summary>
|
|
Gets or sets the name of the angle attenuation function to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.BaseData">
|
|
<summary>
|
|
Gets the <see cref="T:Syroot.NintenTools.Bfres.LightAnimData"/> instance storing initial light parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.LightAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.LightAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.LightAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.LightAnimField">
|
|
<summary>
|
|
Represents flags specifying which fields are animated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.Enable">
|
|
<summary>
|
|
Enabled state is animated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.Position">
|
|
<summary>
|
|
Position is animated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.Rotation">
|
|
<summary>
|
|
Rotation is animated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.DistanceAttn">
|
|
<summary>
|
|
Distance attenuation is animated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.AngleAttn">
|
|
<summary>
|
|
Angle attenuation is animated in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.Color0">
|
|
<summary>
|
|
Color 0 is animated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimField.Color1">
|
|
<summary>
|
|
Color 1 is animated.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.LightAnimData">
|
|
<summary>
|
|
Represents the animatable data of scene lighting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.Enable">
|
|
<summary>
|
|
Enables or disables the light in total.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.Position">
|
|
<summary>
|
|
The spatial origin of the light source for point or spot lights.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.Rotation">
|
|
<summary>
|
|
The spatial rotation of the light source.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.DistanceAttn">
|
|
<summary>
|
|
The distance attenuation of the light.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.AngleAttn">
|
|
<summary>
|
|
The angle attenuation of the light in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.Color0">
|
|
<summary>
|
|
The first light source color.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimData.Color1">
|
|
<summary>
|
|
The second light source color.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.LightAnimDataOffset">
|
|
<summary>
|
|
Gets the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.AnimDataOffset"/> for <see cref="T:Syroot.NintenTools.Bfres.LightAnimData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Enable">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Enable"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.PositionX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Position"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.PositionY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Position"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.PositionZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Position"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.RotationX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.RotationY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.RotationZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Rotation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.DistanceAttnX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.DistanceAttn"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.DistanceAttnY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.DistanceAttn"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.AngleAttnX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.AngleAttn"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.AngleAttnY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.AngleAttn"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Color0R">
|
|
<summary>
|
|
Animates the X (red) component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Color0"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Color0G">
|
|
<summary>
|
|
Animates the Y (green) component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Color0"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Color0B">
|
|
<summary>
|
|
Animates the Z (blue) component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Color0"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Color1R">
|
|
<summary>
|
|
Animates the X (red) component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Color1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Color1G">
|
|
<summary>
|
|
Animates the Y (green) component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Color1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.LightAnimDataOffset.Color1B">
|
|
<summary>
|
|
Animates the Z (blue) component of <see cref="F:Syroot.NintenTools.Bfres.LightAnimData.Color1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SceneAnim">
|
|
<summary>
|
|
Represents an FSCN subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing scene animations controlling camera, light and
|
|
fog settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.SceneAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.SceneAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SceneAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SceneAnim.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SceneAnim.CameraAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.CameraAnim"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SceneAnim.LightAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.LightAnim"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SceneAnim.FogAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.FogAnim"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SceneAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.SceneAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ParamAnimInfo">
|
|
<summary>
|
|
Represents a parameter animation info in a <see cref="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ParamAnimInfo.BeginCurve">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instance in the parent
|
|
<see cref="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ParamAnimInfo.BeginConstant">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instance in the parent
|
|
<see cref="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ParamAnimInfo.ConstantCount">
|
|
<summary>
|
|
Gets or sets the number of <see cref="T:Syroot.NintenTools.Bfres.AnimConstant"/> instances used in the parent
|
|
<see cref="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ParamAnimInfo.SubBindIndex">
|
|
<summary>
|
|
Gets or sets the index of the <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/> in the <see cref="T:Syroot.NintenTools.Bfres.Material"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ParamAnimInfo.Name">
|
|
<summary>
|
|
Gets the name of the animated <see cref="T:Syroot.NintenTools.Bfres.ShaderParam"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShaderParamAnim">
|
|
<summary>
|
|
Represents an FSHU subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing shader parameter animations of a
|
|
<see cref="T:Syroot.NintenTools.Bfres.Model"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances of all
|
|
<see cref="P:Syroot.NintenTools.Bfres.ShaderParamAnim.ShaderParamMatAnims"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.BindModel">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Model"/> instance affected by this animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.BindIndices">
|
|
<summary>
|
|
Gets the indices of the <see cref="T:Syroot.NintenTools.Bfres.Material"/> instances in the <see cref="P:Syroot.NintenTools.Bfres.Model.Materials"/> dictionary to
|
|
bind for each animation. <see cref="F:System.UInt16.MaxValue"/> specifies no binding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.ShaderParamMatAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim"/> instances creating the animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.ShaderParamAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShaderParamAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShaderParamAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim">
|
|
<summary>
|
|
Represents a material parameter animation in a <see cref="T:Syroot.NintenTools.Bfres.ShaderParamAnim"/> subfile.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ShaderParamMatAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ShaderParamMatAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamMatAnim.Name">
|
|
<summary>
|
|
Gets or sets the name of the animated <see cref="T:Syroot.NintenTools.Bfres.Material"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamMatAnim.ParamAnimInfos">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.ParamAnimInfo"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamMatAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamMatAnim.BeginCurve">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> relative to all curves of the parent
|
|
<see cref="P:Syroot.NintenTools.Bfres.ShaderParamAnim.ShaderParamMatAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShaderParamMatAnim.BeginParamAnim">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.ParamAnimInfo"/> relative to all param anim infos of the
|
|
parent <see cref="P:Syroot.NintenTools.Bfres.ShaderParamAnim.ShaderParamMatAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.KeyShapeAnimInfo">
|
|
<summary>
|
|
Represents a key shape animation info in a <see cref="T:Syroot.NintenTools.Bfres.VertexShapeAnim"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.KeyShapeAnimInfo.CurveIndex">
|
|
<summary>
|
|
Gets or sets the index of the curve in the <see cref="T:Syroot.NintenTools.Bfres.VertexShapeAnim"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.KeyShapeAnimInfo.SubBindIndex">
|
|
<summary>
|
|
Gets or sets the index of the <see cref="T:Syroot.NintenTools.Bfres.KeyShape"/> in the <see cref="T:Syroot.NintenTools.Bfres.Shape"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.KeyShapeAnimInfo.Name">
|
|
<summary>
|
|
Gets or sets the name of the <see cref="T:Syroot.NintenTools.Bfres.KeyShape"/> in the <see cref="T:Syroot.NintenTools.Bfres.Shape"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShapeAnim">
|
|
<summary>
|
|
Represents an FSHA subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing shape animations of a <see cref="T:Syroot.NintenTools.Bfres.Model"/>
|
|
instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.ShapeAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ShapeAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances of all
|
|
<see cref="P:Syroot.NintenTools.Bfres.ShapeAnim.VertexShapeAnims"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.BindModel">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Model"/> instance affected by this animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.BindIndices">
|
|
<summary>
|
|
Gets or sets the indices of the <see cref="T:Syroot.NintenTools.Bfres.Shape"/> instances in the <see cref="P:Syroot.NintenTools.Bfres.Model.Shapes"/> dictionary
|
|
to bind for each animation. <see cref="F:System.UInt16.MaxValue"/> specifies no binding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.VertexShapeAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.VertexShapeAnim"/> instances creating the animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.ShapeAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.ShapeAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.ShapeAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShapeAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.ShapeAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.VertexShapeAnim">
|
|
<summary>
|
|
Represents a vertex shape animation in a <see cref="T:Syroot.NintenTools.Bfres.ShapeAnim"/> subfile.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexShapeAnim.Name">
|
|
<summary>
|
|
Gets or sets the name of the animated <see cref="T:Syroot.NintenTools.Bfres.Shape"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexShapeAnim.KeyShapeAnimInfos">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.KeyShapeAnimInfo"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexShapeAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexShapeAnim.BaseDataList">
|
|
<summary>
|
|
Gets or sets the list of base values, excluding the base shape (which is always being initialized with 0f).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexShapeAnim.BeginCurve">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> relative to all curves of the parent
|
|
<see cref="P:Syroot.NintenTools.Bfres.ShapeAnim.VertexShapeAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VertexShapeAnim.BeginKeyShapeAnim">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.KeyShapeAnimInfo"/> relative to all key shape anim infos of
|
|
the parent <see cref="P:Syroot.NintenTools.Bfres.ShapeAnim.VertexShapeAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneAnim">
|
|
<summary>
|
|
Represents the animation of a single <see cref="T:Syroot.NintenTools.Bfres.Bone"/> in a <see cref="T:Syroot.NintenTools.Bfres.SkeletalAnim"/> subfile.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.BoneAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.BoneAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.FlagsBase">
|
|
<summary>
|
|
Gets or sets a set of flags indicating whether initial transformation values exist in
|
|
<see cref="P:Syroot.NintenTools.Bfres.BoneAnim.BaseData"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.FlagsCurve">
|
|
<summary>
|
|
Gets or sets a set of flags indicating whether curves animating the corresponding transformation exist.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.FlagsTransform">
|
|
<summary>
|
|
Gets or sets a set of flags controlling how to transform bones.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.Name">
|
|
<summary>
|
|
Gets or sets the name of the animated <see cref="T:Syroot.NintenTools.Bfres.Bone"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.BeginRotate">
|
|
<summary>
|
|
Gets or sets a field with unknown purpose.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.BeginTranslate">
|
|
<summary>
|
|
Gets or sets a field with unknown purpose.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.BeginBaseTranslate">
|
|
<summary>
|
|
Gets or sets the element offset in the <see cref="P:Syroot.NintenTools.Bfres.BoneAnim.BaseData"/> to an initial translation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.BeginCurve">
|
|
<summary>
|
|
Gets the index of the first <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> relative to all curves of the parent
|
|
<see cref="P:Syroot.NintenTools.Bfres.SkeletalAnim.BoneAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.BoneAnim.BaseData">
|
|
<summary>
|
|
Gets or sets initial transformation values. Only stores specific transformations according to
|
|
<see cref="P:Syroot.NintenTools.Bfres.BoneAnim.FlagsBase"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneAnimFlagsBase">
|
|
<summary>
|
|
Represents if initial values exist for the corresponding transformation in the base animation data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsBase.Scale">
|
|
<summary>
|
|
Initial scaling values exist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsBase.Rotate">
|
|
<summary>
|
|
Initial rotation values exist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsBase.Translate">
|
|
<summary>
|
|
Initial translation values exist.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve">
|
|
<summary>
|
|
Represents if curves exist which animate the corresponding transformation component.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.ScaleX">
|
|
<summary>
|
|
Curve animating the X component of a bone's scale.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.ScaleY">
|
|
<summary>
|
|
Curve animating the Y component of a bone's scale.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.ScaleZ">
|
|
<summary>
|
|
Curve animating the Z component of a bone's scale.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.RotateX">
|
|
<summary>
|
|
Curve animating the X component of a bone's rotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.RotateY">
|
|
<summary>
|
|
Curve animating the Y component of a bone's rotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.RotateZ">
|
|
<summary>
|
|
Curve animating the Z component of a bone's rotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.RotateW">
|
|
<summary>
|
|
Curve animating the W component of a bone's rotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.TranslateX">
|
|
<summary>
|
|
Curve animating the X component of a bone's translation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.TranslateY">
|
|
<summary>
|
|
Curve animating the Y component of a bone's translation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimFlagsCurve.TranslateZ">
|
|
<summary>
|
|
Curve animating the Z component of a bone's translation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneAnimFlagsTransform">
|
|
<summary>
|
|
Represents how a bone transformation has to be applied.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneAnimData">
|
|
<summary>
|
|
Represents the animatable data of a <see cref="T:Syroot.NintenTools.Bfres.Bone"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimData.Scale">
|
|
<summary>
|
|
The scaling of the bone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimData.Translate">
|
|
<summary>
|
|
The translation of the bone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimData.Padding">
|
|
<summary>
|
|
An unused field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimData.Rotate">
|
|
<summary>
|
|
The rotation of the bone.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.BoneAnimDataOffset">
|
|
<summary>
|
|
Gets the <see cref="P:Syroot.NintenTools.Bfres.AnimCurve.AnimDataOffset"/> for <see cref="T:Syroot.NintenTools.Bfres.BoneAnimData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.Flags">
|
|
<summary>
|
|
Animates <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Flags"/> (never seen in files).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.ScaleX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Scale"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.ScaleY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Scale"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.ScaleZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Scale"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.TranslateX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Translate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.TranslateY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Translate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.TranslateZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Translate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.RotateX">
|
|
<summary>
|
|
Animates the X component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Rotate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.RotateY">
|
|
<summary>
|
|
Animates the Y component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Rotate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.RotateZ">
|
|
<summary>
|
|
Animates the Z component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Rotate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.BoneAnimDataOffset.RotateW">
|
|
<summary>
|
|
Animates the W component of <see cref="F:Syroot.NintenTools.Bfres.BoneAnimData.Rotate"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SkeletalAnim">
|
|
<summary>
|
|
Represents an FSKA subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing armature animations of <see cref="T:Syroot.NintenTools.Bfres.Bone"/>
|
|
instances in a <see cref="T:Syroot.NintenTools.Bfres.Skeleton"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.SkeletalAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.SkeletalAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.FlagsAnimSettings">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.SkeletalAnimFlags"/> mode used to control looping and baked settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.FlagsScale">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.SkeletalAnimFlagsScale"/> mode used to store scaling values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.FlagsRotate">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.SkeletalAnimFlagsRotate"/> mode used to store rotation values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances of all
|
|
<see cref="P:Syroot.NintenTools.Bfres.SkeletalAnim.BoneAnims"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.BoneAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.BoneAnim"/> instances creating the animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.BindSkeleton">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Skeleton"/> instance affected by this animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.BindIndices">
|
|
<summary>
|
|
Gets or sets the indices of the <see cref="T:Syroot.NintenTools.Bfres.Bone"/> instances in the <see cref="P:Syroot.NintenTools.Bfres.Skeleton.Bones"/> dictionary
|
|
to bind for each animation. <see cref="F:System.UInt16.MaxValue"/> specifies no binding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.SkeletalAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.SkeletalAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SkeletalAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SkeletalAnimFlagsScale">
|
|
<summary>
|
|
Represents the data format in which scaling values are stored.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlagsScale.None">
|
|
<summary>
|
|
No scaling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlagsScale.Standard">
|
|
<summary>
|
|
Default scaling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlagsScale.Maya">
|
|
<summary>
|
|
Autodesk Maya scaling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlagsScale.Softimage">
|
|
<summary>
|
|
Autodesk Softimage scaling.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.SkeletalAnimFlagsRotate">
|
|
<summary>
|
|
Represents the data format in which rotation values are stored.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlagsRotate.Quaternion">
|
|
<summary>
|
|
Quaternion, 4 components.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.SkeletalAnimFlagsRotate.EulerXYZ">
|
|
<summary>
|
|
Euler XYZ, 3 components.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.PatternAnimInfo">
|
|
<summary>
|
|
Represents a pattern animation info in a <see cref="T:Syroot.NintenTools.Bfres.TexPatternMatAnim"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.PatternAnimInfo.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ShaderParamAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.PatternAnimInfo.CurveIndex">
|
|
<summary>
|
|
Gets or sets the index of the curve in the <see cref="T:Syroot.NintenTools.Bfres.TexPatternMatAnim"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.PatternAnimInfo.SubBindIndex">
|
|
<summary>
|
|
Gets or sets the index of the texture in the <see cref="T:Syroot.NintenTools.Bfres.Material"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.PatternAnimInfo.Name">
|
|
<summary>
|
|
Gets or sets the name of the <see cref="T:Syroot.NintenTools.Bfres.Sampler"/> in the <see cref="T:Syroot.NintenTools.Bfres.Material"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TexPatternAnim">
|
|
<summary>
|
|
Represents an FTXP subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing texture material pattern animations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.TexPatternAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.ShapeAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances of all
|
|
<see cref="P:Syroot.NintenTools.Bfres.TexPatternAnim.TexPatternMatAnims"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.BindModel">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Model"/> instance affected by this animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.BindIndices">
|
|
<summary>
|
|
Gets or sets the indices of the <see cref="T:Syroot.NintenTools.Bfres.Material"/> instances in the <see cref="P:Syroot.NintenTools.Bfres.Model.Materials"/>
|
|
dictionary to bind for each animation. <see cref="F:System.UInt16.MaxValue"/> specifies no binding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.TexPatternMatAnims">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.TexPatternAnim"/> instances creating the animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.TextureRefs">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.TextureRef"/> instances pointing to <see cref="T:Syroot.NintenTools.Bfres.Texture"/> instances
|
|
participating in the animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.TextureRefNames">
|
|
<summary>
|
|
Note used for older bfres files
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.TextureRef"/> instances pointing to <see cref="T:Syroot.NintenTools.Bfres.Texture"/> instances
|
|
participating in the animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.TexPatternAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TexPatternAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexPatternAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.TexPatternAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.TexPatternMatAnim">
|
|
<summary>
|
|
Represents a texture pattern material animation in a <see cref="T:Syroot.NintenTools.Bfres.TexPatternAnim"/> subfile.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternMatAnim.Name">
|
|
<summary>
|
|
Gets the name of the animated <see cref="T:Syroot.NintenTools.Bfres.Material"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternMatAnim.PatternAnimInfos">
|
|
<summary>
|
|
Gets or sets the list of <see cref="T:Syroot.NintenTools.Bfres.PatternAnimInfo"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternMatAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternMatAnim.BaseDataList">
|
|
<summary>
|
|
Gets or sets the initial <see cref="T:Syroot.NintenTools.Bfres.PatternAnimInfo"/> indices.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternMatAnim.BeginCurve">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> relative to all curves of the parent
|
|
<see cref="P:Syroot.NintenTools.Bfres.TexPatternAnim.TexPatternMatAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.TexPatternMatAnim.BeginPatAnim">
|
|
<summary>
|
|
Gets or sets the index of the first <see cref="T:Syroot.NintenTools.Bfres.PatternAnimInfo"/> relative to all param anim infos of the
|
|
parent <see cref="P:Syroot.NintenTools.Bfres.TexPatternAnim.TexPatternMatAnims"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.Texture">
|
|
<summary>
|
|
Represents an FMDL subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing multi-dimensional texture data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.Texture.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.Texture"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.CompSelR">
|
|
<summary>
|
|
Gets or sets the source channel to map to the R (red) channel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.CompSelG">
|
|
<summary>
|
|
Gets or sets the source channel to map to the G (green) channel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.CompSelB">
|
|
<summary>
|
|
Gets or sets the source channel to map to the B (blue) channel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.CompSelA">
|
|
<summary>
|
|
Gets or sets the source channel to map to the A (alpha) channel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in <see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/>
|
|
instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Width">
|
|
<summary>
|
|
Gets or sets the width of the texture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Height">
|
|
<summary>
|
|
Gets or sets the height of the texture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Depth">
|
|
<summary>
|
|
Gets or sets the depth of the texture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.MipCount">
|
|
<summary>
|
|
Gets or sets the number of mipmaps stored in the <see cref="P:Syroot.NintenTools.Bfres.Texture.MipData"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Swizzle">
|
|
<summary>
|
|
Gets or sets the swizzling value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Alignment">
|
|
<summary>
|
|
Gets or sets the swizzling alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Pitch">
|
|
<summary>
|
|
Gets or sets the pixel swizzling stride.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.UseSRGB">
|
|
<summary>
|
|
Gets or sets the desired texture data buffer format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Format">
|
|
<summary>
|
|
Gets or sets the desired texture data buffer format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Dim">
|
|
<summary>
|
|
Gets or sets the shape of the texture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.AAMode">
|
|
<summary>
|
|
Gets or sets the number of samples for the texture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Use">
|
|
<summary>
|
|
Gets or sets the texture data usage hint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.TileMode">
|
|
<summary>
|
|
Gets or sets the tiling mode.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.MipOffsets">
|
|
<summary>
|
|
Gets or sets the offsets in the <see cref="P:Syroot.NintenTools.Bfres.Texture.MipData"/> array to the data of the mipmap level corresponding
|
|
to the array index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.Data">
|
|
<summary>
|
|
Gets or sets the raw texture data bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.MipData">
|
|
<summary>
|
|
Gets or sets the raw mipmap level data bytes for all levels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.Texture.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.Texture.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.VisibilityAnim">
|
|
<summary>
|
|
Represents an FVIS subfile in a <see cref="T:Syroot.NintenTools.Bfres.ResFile"/>, storing visibility animations of <see cref="T:Syroot.NintenTools.Bfres.Bone"/> or
|
|
<see cref="T:Syroot.NintenTools.Bfres.Material"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syroot.NintenTools.Bfres.VisibilityAnim.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Syroot.NintenTools.Bfres.VisibilityAnim"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.Name">
|
|
<summary>
|
|
Gets or sets the name with which the instance can be referenced uniquely in
|
|
<see cref="T:Syroot.NintenTools.Bfres.ResDict`1"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.Path">
|
|
<summary>
|
|
Gets or sets the path of the file which originally supplied the data of this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.Flags">
|
|
<summary>
|
|
Gets or sets flags controlling how animation data is stored or how the animation should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.Type">
|
|
<summary>
|
|
Gets or sets the kind of data the animation controls.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.FrameCount">
|
|
<summary>
|
|
Gets or sets the total number of frames this animation plays.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.BakedSize">
|
|
<summary>
|
|
Gets or sets the number of bytes required to bake all <see cref="P:Syroot.NintenTools.Bfres.VisibilityAnim.Curves"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.BindModel">
|
|
<summary>
|
|
Gets or sets the <see cref="T:Syroot.NintenTools.Bfres.Model"/> instance affected by this animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.BindIndices">
|
|
<summary>
|
|
Gets or sets the indices of entries in the <see cref="P:Syroot.NintenTools.Bfres.Skeleton.Bones"/> or <see cref="P:Syroot.NintenTools.Bfres.Model.Materials"/>
|
|
dictionaries to bind to for each animation. <see cref="F:System.UInt16.MaxValue"/> specifies no binding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.Names">
|
|
<summary>
|
|
Gets or sets the names of entries in the <see cref="P:Syroot.NintenTools.Bfres.Skeleton.Bones"/> or <see cref="P:Syroot.NintenTools.Bfres.Model.Materials"/>
|
|
dictionaries to bind to for each animation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.Curves">
|
|
<summary>
|
|
Gets or sets <see cref="T:Syroot.NintenTools.Bfres.AnimCurve"/> instances animating properties of objects stored in this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.BaseDataList">
|
|
<summary>
|
|
Gets or sets boolean values storing the initial visibility for each <see cref="T:Syroot.NintenTools.Bfres.Bone"/> or
|
|
<see cref="T:Syroot.NintenTools.Bfres.Material"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syroot.NintenTools.Bfres.VisibilityAnim.UserData">
|
|
<summary>
|
|
Gets or sets customly attached <see cref="P:Syroot.NintenTools.Bfres.VisibilityAnim.UserData"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.VisibilityAnimFlags">
|
|
<summary>
|
|
Represents flags specifying how animation data is stored or should be played.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.VisibilityAnimFlags.BakedCurve">
|
|
<summary>
|
|
The stored curve data has been baked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.VisibilityAnimFlags.Looping">
|
|
<summary>
|
|
The animation repeats from the start after the last frame has been played.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syroot.NintenTools.Bfres.VisibilityAnimType">
|
|
<summary>
|
|
Represents the kind of data the visibility animation controls.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.VisibilityAnimType.Bone">
|
|
<summary>
|
|
Bone visiblity is controlled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syroot.NintenTools.Bfres.VisibilityAnimType.Material">
|
|
<summary>
|
|
Material visibility is controlled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:AutoIt.Common.TextEncodingDetect.NullSuggestsBinary">
|
|
<summary>
|
|
Sets if the presence of nulls in a buffer indicate the buffer is binary data rather than text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.GetBomLengthFromEncodingMode(AutoIt.Common.TextEncodingDetect.Encoding)">
|
|
<summary>
|
|
Gets the BOM length for a given Encoding mode.
|
|
</summary>
|
|
<param name="encoding"></param>
|
|
<returns>The BOM length.</returns>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.CheckBom(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Checks for a BOM sequence in a byte buffer.
|
|
</summary>
|
|
<param name="buffer"></param>
|
|
<param name="size"></param>
|
|
<returns>Encoding type or Encoding.None if no BOM.</returns>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.DetectEncoding(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Automatically detects the Encoding type of a given byte buffer.
|
|
</summary>
|
|
<param name="buffer">The byte buffer.</param>
|
|
<param name="size">The size of the byte buffer.</param>
|
|
<returns>The Encoding type or Encoding.None if unknown.</returns>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.CheckUtf16NewlineChars(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Checks if a buffer contains text that looks like utf16 by scanning for
|
|
newline chars that would be present even in non-english text.
|
|
</summary>
|
|
<param name="buffer">The byte buffer.</param>
|
|
<param name="size">The size of the byte buffer.</param>
|
|
<returns>Encoding.none, Encoding.Utf16LeNoBom or Encoding.Utf16BeNoBom.</returns>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.DoesContainNulls(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Checks if a buffer contains any nulls. Used to check for binary vs text data.
|
|
</summary>
|
|
<param name="buffer">The byte buffer.</param>
|
|
<param name="size">The size of the byte buffer.</param>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.CheckUtf16Ascii(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Checks if a buffer contains text that looks like utf16. This is done based
|
|
on the use of nulls which in ASCII/script like text can be useful to identify.
|
|
</summary>
|
|
<param name="buffer">The byte buffer.</param>
|
|
<param name="size">The size of the byte buffer.</param>
|
|
<returns>Encoding.none, Encoding.Utf16LeNoBom or Encoding.Utf16BeNoBom.</returns>
|
|
</member>
|
|
<member name="M:AutoIt.Common.TextEncodingDetect.CheckUtf8(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Checks if a buffer contains valid utf8.
|
|
</summary>
|
|
<param name="buffer">The byte buffer.</param>
|
|
<param name="size">The size of the byte buffer.</param>
|
|
<returns>
|
|
Encoding type of Encoding.None (invalid UTF8), Encoding.Utf8NoBom (valid utf8 multibyte strings) or
|
|
Encoding.ASCII (data in 0.127 range).
|
|
</returns>
|
|
<returns>2</returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|