x/gtav-src
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
gtav-src/tools_ng/bin/audio/DstarToReaperGTA/RSG.Platform.xml
T
x a6770644bb init gta
2025-09-29 00:52:08 +02:00

2570 lines
117 KiB
XML
Executable File
Raw Permalink Blame History

<?xml version="1.0"?>
<doc>
<assembly>
<name>RSG.Platform</name>
</assembly>
<members>
<member name="T:RSG.Platform.Attributes.AllowAdditionalPeriodAttribute">
<summary>
Attribute that allows <see cref="T:RSG.Platform.FileType"/> fields to be defined as allowing
additional period characters in their filenames without being treated as a
container format. This was originally added to support period characters in
C# Script Object filenames and its usage should be very infrequent.
</summary>
<remarks>
See url:bugstar:2851438 for more details.
</remarks>
</member>
<member name="F:RSG.Platform.Attributes.AllowAdditionalPeriodAttribute.DefaultValue">
<summary>
Define a default value.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.AllowAdditionalPeriodAttribute.#ctor(System.Boolean)">
<summary>
Constructor.
</summary>
<param name="allowAdditionalPeriod">
Attribute value.
</param>
</member>
<member name="P:RSG.Platform.Attributes.AllowAdditionalPeriodAttribute.AllowAdditionalPeriod">
<summary>
Gets a value indicating whether this type allows additional period characters.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.CanLiveEditAttribute">
<summary>
Attribute to describe whether game builds have live edit features available.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.CanLiveEditAttribute.#ctor(System.Boolean)">
<summary>
Constructor.
</summary>
<param name="canLiveEdit">
Attribute value.
</param>
</member>
<member name="P:RSG.Platform.Attributes.CanLiveEditAttribute.CanLiveEdit">
<summary>
Gets a value indicating whether this build can be live edited.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.GamePlatformStringAttribute">
<summary>
Defines a platform string as used by RAG bank protocol for platform
identification.
</summary>
<remarks>
See RAGE source tree: base\src\bank\packet.cpp.
</remarks>
</member>
<member name="M:RSG.Platform.Attributes.GamePlatformStringAttribute.#ctor(System.String)">
<summary>
Constructor.
</summary>
<param name="platform">
Platform string.
</param>
</member>
<member name="P:RSG.Platform.Attributes.GamePlatformStringAttribute.GamePlatform">
<summary>
Gets the associated game platform string.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.ResourceFileTypeAttribute">
<summary>
Attribute that whether a <see cref="T:RSG.Platform.FileType"/> is a resource.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.ResourceFileTypeAttribute.#ctor(System.Boolean,RSG.Platform.ResourceCompressionType)">
<summary>
Initialises a new instance of the <see cref="T:RSG.Platform.Attributes.ResourceFileTypeAttribute"/> class.
</summary>
<param name="isResource">
Whether the field specifies a file type that is a resource..
</param>
<param name="compressionType">
Type of compression used on the resource (if applicable).
</param>
</member>
<member name="P:RSG.Platform.Attributes.ResourceFileTypeAttribute.IsResource">
<summary>
Gets a value indicating whether the file is a resource (default: false).
</summary>
</member>
<member name="P:RSG.Platform.Attributes.ResourceFileTypeAttribute.CompressionType">
<summary>
Gets the type of compression used on the resource (if applicable).
</summary>
</member>
<member name="T:RSG.Platform.Attributes.PlatformGenerationAndFeaturesAttribute">
<summary>
Attribute for defining platform hardware generation and features.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.PlatformGenerationAndFeaturesAttribute.#ctor(RSG.Platform.PlatformGeneration,RSG.Platform.PlatformFeatures)">
<summary>
Constructor.
</summary>
<param name="generation">
Generation of platform.
</param>
<param name="features">
Platform features.
</param>
</member>
<member name="P:RSG.Platform.Attributes.PlatformGenerationAndFeaturesAttribute.HardwareGeneration">
<summary>
Gets the platform hardware generation.
</summary>
</member>
<member name="P:RSG.Platform.Attributes.PlatformGenerationAndFeaturesAttribute.HardwareFeatures">
<summary>
Gets the platform hardware features.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.FileTypeExtensionAttribute">
<summary>
Attribute that assigns an export and platform extension to a FileType
enum value. This is used for encoding the transitions for the pipeline.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.FileTypeExtensionAttribute.#ctor(System.String,System.String)">
<summary>
Constructor; specifying the export and platform extension strings.
</summary>
<param name="exportExt">
Export/independent platform extension.
</param>
<param name="platformExt">
Platform extension.
</param>
</member>
<member name="P:RSG.Platform.Attributes.FileTypeExtensionAttribute.PlatformExtension">
<summary>
Gets the platform extension pattern string assigned to a FileType enum value.
'?' character will be substituted for platform filename conversion.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.VisualStudioPlatformAttribute">
<summary>
Attribute for defining the VisualStudioPlatformAttribute string on an enum value.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.VisualStudioPlatformAttribute.#ctor(System.String)">
<summary>
Constructor.
</summary>
<param name="setting">
Visual Studio platform string (e.g. Win32, x64, Durango).
</param>
</member>
<member name="P:RSG.Platform.Attributes.VisualStudioPlatformAttribute.VisualStudioPlatform">
<summary>
Gets the CompilerSetting string assigned to enum value.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.Is64BitArchitectureAttribute">
<summary>
Attribute that specifies the platform is a 64-bit architecture.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.Is64BitArchitectureAttribute.#ctor(System.Boolean)">
<summary>
Constructor.
</summary>
<param name="is64Bit">
Whether the field specifies a platform that is 64-bit.
</param>
</member>
<member name="P:RSG.Platform.Attributes.Is64BitArchitectureAttribute.Is64BitArchitecture">
<summary>
Gets a value indicating whether the platform is 64-bit.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.PlatformEndiannessAttribute">
<summary>
Attribute for defining platform endianness (byte-order).
</summary>
</member>
<member name="M:RSG.Platform.Attributes.PlatformEndiannessAttribute.#ctor(RSG.Platform.Endianness)">
<summary>
Constructor.
</summary>
<param name="endianness">
Endianness of the platform.
</param>
</member>
<member name="P:RSG.Platform.Attributes.PlatformEndiannessAttribute.Endianness">
<summary>
Gets the Platform endianness.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.PlatformExtensionCharacterAttribute">
<summary>
Attribute for defining the Ragebuilder Platform character.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.PlatformExtensionCharacterAttribute.#ctor(System.Char)">
<summary>
Constructor.
</summary>
<param name="character">
PLatform extension character.
</param>
</member>
<member name="P:RSG.Platform.Attributes.PlatformExtensionCharacterAttribute.ExtensionCharacter">
<summary>
Gets the Ragebuilder Platform character assigned to enum value.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.RagebuilderPlatformAttribute">
<summary>
Attribute for defining the Ragebuilder Platform string on an enum value.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.RagebuilderPlatformAttribute.#ctor(System.String)">
<summary>
Constructor.
</summary>
<param name="platform">
Ragebuilder platform string.
</param>
</member>
<member name="P:RSG.Platform.Attributes.RagebuilderPlatformAttribute.RagebuilderPlatform">
<summary>
Gets the Ragebuilder Platform string assigned to enum value.
</summary>
</member>
<member name="T:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute">
<summary>
Attribute for defining the Ragebuilder Texture Template extension string.
</summary>
</member>
<member name="M:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute.#ctor(System.String,RSG.Platform.TextureTemplateModifiers)">
<summary>
Initialises a new instance of the <see cref="T:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute"/> class.
</summary>
<param name="extension">
Extension string.
</param>
<param name="modifiers">
</param>
</member>
<member name="P:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute.TextureTemplateExtension">
<summary>
Gets the Texture template extension (e.g. ".win64.tcp").
</summary>
</member>
<member name="P:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute.TextureTemplateUhdExtension">
<summary>
Gets the Texture template extension for the HD modifier template (e.g. ".win64hd.tcp").
</summary>
</member>
<member name="P:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute.TextureTemplateModifiers">
<summary>
Gets the Texture template modifiers.
</summary>
<remarks>
See our Sparse Target support at https://hub.rockstargames.com/display/RSGTOOLS/Asset+Pipeline+Spec+-+Sparse+Target+Data.
</remarks>
</member>
<member name="T:RSG.Platform.Conversion.BigEndianBitConverter">
<summary>
EndianBitConverter that converts to/from big-endian byte arrays.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.BigEndianBitConverter.IsLittleEndian">
<summary>
Gets a value indicating whether this is little-endian.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.BigEndianBitConverter.Endianness">
<summary>
Gets the Endianness (byte-order) in which data is converted using this class.
</summary>
</member>
<member name="M:RSG.Platform.Conversion.BigEndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the specified number of bytes from value to buffer, starting at index.
</summary>
<param name="value"></param>
<param name="bytes"></param>
<param name="buffer"></param>
<param name="index"></param>
</member>
<member name="M:RSG.Platform.Conversion.BigEndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
</summary>
<param name="buffer"></param>
<param name="startIndex"></param>
<param name="count"></param>
<returns></returns>
</member>
<member name="T:RSG.Platform.Conversion.EndianBitConverter">
<summary>
Abstract base class for endian-aware bit-converters.
</summary>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.#cctor">
<summary>
Static Constructor.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianBitConverter.Little">
<summary>
Gets the Little-endian bit-converter.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianBitConverter.Big">
<summary>
Gets the Big-endian bit converter.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianBitConverter.IsLittleEndian">
<summary>
Gets a value indicating whether the converter is little-endian.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianBitConverter.Endianness">
<summary>
Gets the Endianness (byte-order) in which data is converted using this class.
</summary>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.DoubleToInt64Bits(System.Double)">
<summary>
Converts the specified double-precision floating point number to a 64-bit
signed integer.
</summary>
<param name="value">The number to convert.</param>
<returns>A 64-bit signed integer whose value is equivalent to value.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.Int64BitsToDouble(System.Int64)">
<summary>
Converts the specified 64-bit signed integer to a double-precision floating
point number.
</summary>
<param name="value">The number to convert.</param>
<returns>A double-precision floating point number whose value is equivalent to value.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.SingleToInt32Bits(System.Single)">
<summary>
Converts the specified single-precision floating point number to a 32-bit
signed integer.
</summary>
<param name="value">The number to convert.</param>
<returns>A 32-bit signed integer whose value is equivalent to value.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.Int32BitsToSingle(System.Int32)">
<summary>
Converts the specified 32-bit signed integer to a single-precision floating
point number.
</summary>
<param name="value">The number to convert.</param>
<returns>A single-precision floating point number whose value is equivalent to value.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Boolean)">
<summary>
Returns the specified Boolean value as an array of bytes.
</summary>
<param name="value">A Boolean value.</param>
<returns>An array of bytes with length 1.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Char)">
<summary>
Returns the specified Unicode character value as an array of bytes.
</summary>
<param name="value">A character to convert.</param>
<returns>An array of bytes with length 2.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Double)">
<summary>
Returns the specified double-precision floating point value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 8.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Int16)">
<summary>
Returns the specified 16-bit signed integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 2.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Int32)">
<summary>
Returns the specified 32-bit signed integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 4.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Int64)">
<summary>
Returns the specified 64-bit signed integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 8.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Single)">
<summary>
Returns the specified single-precision floating point value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 4.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.UInt16)">
<summary>
Returns the specified 16-bit unsigned integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 2.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.UInt32)">
<summary>
Returns the specified 32-bit unsigned integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 4.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.UInt64)">
<summary>
Returns the specified 64-bit unsigned integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 8.</returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToBoolean(System.Byte[],System.Int32)">
<summary>
Returns a Boolean value converted from one byte at a specified position in
a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>true if the byte at startIndex in value is nonzero; otherwise, false.</returns>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">startIndex is less than zero or greater than the length of value minus 1.</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToChar(System.Byte[],System.Int32)">
<summary>
Returns a Unicode character converted from two bytes at a specified position
in a byte array.
</summary>
<param name="value">An array.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A character formed by two bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToDecimal(System.Byte[],System.Int32)">
<summary>
Returns a Decimal value converted from sixteen bytes at a specified
position in a byte array.
</summary>
<param name="value"></param>
<param name="startIndex"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToSingle(System.Byte[],System.Int32)">
<summary>
Returns a single-precision floating point number converted from four bytes
at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>
A single-precision floating point number formed by four bytes beginning at
startIndex.
</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToDouble(System.Byte[],System.Int32)">
<summary>
Returns a double-precision floating point number converted from eight bytes
at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>
A double precision floating point number formed by eight bytes beginning
at startIndex.
</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToInt16(System.Byte[],System.Int32)">
<summary>
Returns a 16-bit signed integer converted from two bytes at a specified position
in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 16-bit signed integer formed by two bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToInt32(System.Byte[],System.Int32)">
<summary>
Returns a 32-bit signed integer converted from four bytes at a specified
position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 32-bit signed integer formed by four bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToInt64(System.Byte[],System.Int32)">
<summary>
Returns a 64-bit signed integer converted from eight bytes at a specified
position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 64-bit signed integer formed by eight bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToString(System.Byte[])">
<summary>
Converts the numeric value of each element of a specified array of bytes
to its equivalent hexadecimal string representation.
</summary>
<param name="value">An array of bytes.</param>
<returns>
A string of hexadecimal pairs separated by hyphens, where each pair represents
the corresponding element in value; for example, "7F-2C-4A-00".
</returns>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToString(System.Byte[],System.Int32)">
<summary>
Converts the numeric value of each element of a specified subarray of bytes
to its equivalent hexadecimal string representation.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>
A string of hexadecimal pairs separated by hyphens, where each pair represents
the corresponding element in a subarray of value; for example, "7F-2C-4A-00".
</returns>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToString(System.Byte[],System.Int32,System.Int32)">
<summary>
Converts the numeric value of each element of a specified subarray of bytes
to its equivalent hexadecimal string representation.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<param name="length">The number of array elements in value to convert.</param>
<returns>
A string of hexadecimal pairs separated by hyphens, where each pair represents
the corresponding element in a subarray of value; for example, "7F-2C-4A-00".
</returns>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex or length is less than zero.-or-startIndex is greater than zero
and is greater than or equal to the length of value.
</exception>
<exception cref="T:System.ArgumentException">
The combination of startIndex and length does not specify a position within
value; that is, the startIndex parameter is greater than the length of value
minus the length parameter.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToUInt16(System.Byte[],System.Int32)">
<summary>
Returns a 16-bit unsigned integer converted from two bytes at a specified
position in a byte array.
</summary>
<param name="value">The array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 16-bit unsigned integer formed by two bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">startIndex equals the length of value minus 1.</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToUInt32(System.Byte[],System.Int32)">
<summary>
Returns a 32-bit unsigned integer converted from four bytes at a specified
position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 32-bit unsigned integer formed by four bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 3, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.ToUInt64(System.Byte[],System.Int32)">
<summary>
Returns a 64-bit unsigned integer converted from eight bytes at a specified
position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 64-bit unsigned integer formed by the eight bytes beginning at startIndex.</returns>
<exception cref="T:System.ArgumentException">
startIndex is greater than or equal to the length of value minus 7, and is
less than or equal to the length of value minus 1.
</exception>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus 1.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Decimal,System.Byte[],System.Int32)">
<summary>
Copies the specified decimal value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">A character to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the given number of bytes from the least-specific
end of the specified value into the specified byte array, beginning
at the specified index.
This is used to implement the other CopyBytes methods.
</summary>
<param name="value">The value to copy bytes for</param>
<param name="bytes">The number of significant bytes to copy</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Boolean,System.Byte[],System.Int32)">
<summary>
Copies the specified Boolean value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">A Boolean value.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Char,System.Byte[],System.Int32)">
<summary>
Copies the specified Unicode character value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">A character to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Double,System.Byte[],System.Int32)">
<summary>
Copies the specified double-precision floating point value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Int16,System.Byte[],System.Int32)">
<summary>
Copies the specified 16-bit signed integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the specified 32-bit signed integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Int64,System.Byte[],System.Int32)">
<summary>
Copies the specified 64-bit signed integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.Single,System.Byte[],System.Int32)">
<summary>
Copies the specified single-precision floating point value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.UInt16,System.Byte[],System.Int32)">
<summary>
Copies the specified 16-bit unsigned integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.UInt32,System.Byte[],System.Int32)">
<summary>
Copies the specified 32-bit unsigned integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytes(System.UInt64,System.Byte[],System.Int32)">
<summary>
Copies the specified 64-bit unsigned integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the given number of bytes from the least-specific
end of the specified value into the specified byte array, beginning
at the specified index.
This must be implemented in concrete derived classes, but the implementation
may assume that the value will fit into the buffer.
</summary>
<param name="value">The value to copy bytes for</param>
<param name="bytes">The number of significant bytes to copy</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Convert specified subrange of value array.
</summary>
<param name="value"></param>
<param name="startIndex"></param>
<param name="count"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CheckedConvert(System.Byte[],System.Int32,System.Int32)">
<summary>
Validate arguments prior to converting specified subrange of Byte array.
</summary>
<param name="value"></param>
<param name="startIndex"></param>
<param name="count"></param>
<returns></returns>
<exception cref="T:System.ArgumentNullException">value is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or off the end of the specified array.
</exception>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.CheckArgs(System.Byte[],System.Int32,System.Int32)">
<summary>
Validate arguments.
</summary>
<param name="value"></param>
<param name="startIndex"></param>
<param name="count"></param>
</member>
<member name="M:RSG.Platform.Conversion.EndianBitConverter.GetBytes(System.Int64,System.Int32)">
<summary>
Returns an array with the given number of bytes formed
from the least significant bytes of the specified value.
This is used to implement the other GetBytes methods.
</summary>
<param name="value">The value to get bytes for</param>
<param name="bytes">The number of significant bytes to return</param>
</member>
<member name="T:RSG.Platform.Conversion.EndianBitConverter.Int32SingleOverlapStruct">
<summary>
Structure to define overlapped Int32/Single data.
</summary>
</member>
<member name="F:RSG.Platform.Conversion.EndianBitConverter.Int32SingleOverlapStruct.Integer">
<summary>
Integer storage field.
</summary>
</member>
<member name="F:RSG.Platform.Conversion.EndianBitConverter.Int32SingleOverlapStruct.Float">
<summary>
Floating-point storage field.
</summary>
</member>
<member name="T:RSG.Platform.Conversion.EndianConverter">
<summary>
Simple endian byte-swapping converter (if you just know that you need
to byte-swap data).
</summary>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.#cctor">
<summary>
Static constructor.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianConverter.CurrentEndianness">
<summary>
Gets the current architecture endianness.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianConverter.IsLittleEndian">
<summary>
Gets a value indicating whether the architecture is little-endian.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.EndianConverter.IsBigEndian">
<summary>
Gets a value indicating whether the architecture is big-endian.
</summary>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.SwapInt16(System.Int16)">
<summary>
</summary>
<param name="v"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.SwapUInt16(System.UInt16)">
<summary>
</summary>
<param name="v"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.SwapInt32(System.Int32)">
<summary>
</summary>
<param name="v"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.SwapUInt32(System.UInt32)">
<summary>
</summary>
<param name="v"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.SwapInt64(System.Int64)">
<summary>
</summary>
<param name="v"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Conversion.EndianConverter.SwapUInt64(System.UInt64)">
<summary>
</summary>
<param name="v"></param>
<returns></returns>
</member>
<member name="T:RSG.Platform.Conversion.LittleEndianBitConverter">
<summary>
EndianBitConverter that converts to/from little-endian byte arrays.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.LittleEndianBitConverter.IsLittleEndian">
<summary>
Gets a value indicating whether this convert is little-endian.
</summary>
</member>
<member name="P:RSG.Platform.Conversion.LittleEndianBitConverter.Endianness">
<summary>
Gets the Endianness (byte-order) in which data is converted using this class.
</summary>
</member>
<member name="M:RSG.Platform.Conversion.LittleEndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the specified number of bytes from value to buffer, starting at index.
</summary>
<param name="value"></param>
<param name="bytes"></param>
<param name="buffer"></param>
<param name="index"></param>
</member>
<member name="M:RSG.Platform.Conversion.LittleEndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
</summary>
<param name="buffer"></param>
<param name="startIndex"></param>
<param name="count"></param>
<returns></returns>
</member>
<member name="T:RSG.Platform.Endianness">
<summary>
Endianness enumeration.
</summary>
</member>
<member name="F:RSG.Platform.Endianness.LittleEndian">
<summary>
Little endian; least significant byte first.
</summary>
</member>
<member name="F:RSG.Platform.Endianness.BigEndian">
<summary>
Big endian; most significant byte first.
</summary>
</member>
<member name="T:RSG.Platform.FileTypeExtensions">
<summary>
<see cref="T:RSG.Platform.FileType"/> extension methods.
</summary>
</member>
<member name="F:RSG.Platform.FileTypeExtensions.FileTypeExtensionAttributes">
<summary>
Field for caching the <see cref="T:RSG.Platform.Attributes.FileTypeExtensionAttribute"/> attribute values.
Since these are defined by compile-time attributes we can cache them.
</summary>
</member>
<member name="F:RSG.Platform.FileTypeExtensions.FileTypeResourceAttributes">
<summary>
Field for caching the <see cref="F:RSG.Platform.FileTypeExtensions.FileTypeResourceAttributes"/> attribute values.
Since these are defined by compile-time attributes we can cache them.
</summary>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.GetExtensions(RSG.Platform.FileType,System.String@,System.String@)">
<summary>
FileType enumeration extension method that returns both the export
and platform extension strings for a particular FileType value.
</summary>
<param name="value">
<see cref="T:RSG.Platform.FileType"/> value.
</param>
<param name="exportExt">
Export/independent string extension (including ".").
</param>
<param name="platformExt">
Platform string extension (including ".").
</param>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.GetExportExtension(RSG.Platform.FileType)">
<summary>
FileType enumeration extension method that returns the export
extension String for a particular FileType value.
</summary>
<param name="value">
<see cref="T:RSG.Platform.FileType"/> value.
</param>
<returns>
<see cref="T:System.String"/> extension (including ".").
</returns>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.GetPlatformExtension(RSG.Platform.FileType)">
<summary>
FileType enumeration extension method that returns the platform
extension String for a particular FileType value.
</summary>
<param name="value">
<see cref="T:RSG.Platform.FileType"/> value.
</param>
<returns>
<see cref="T:System.String"/> platform extension (including ".").
</returns>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.GetPlatformExtension(RSG.Platform.FileType,RSG.Platform.Platform)">
<summary>
Return the extension string for a platforms file type.
</summary>
<param name="value">
<see cref="T:RSG.Platform.FileType"/> value.
</param>
<param name="platform">
Platform to determine extension.
</param>
<returns>
File extension (including ".").
</returns>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.GetAllowAdditionalPeriod(RSG.Platform.FileType)">
<summary>
Return the value of Allow Additional Period attribute for any given
<see cref="T:RSG.Platform.FileType"/>.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.IsResource(RSG.Platform.FileType)">
<summary>
Return a value indicating whether this <see cref="T:RSG.Platform.FileType"/> is a resource.
</summary>
<param name="value">
<see cref="T:RSG.Platform.FileType"/> to check.
</param>
<returns>
true if the type is a resource type; false otherwise.
</returns>
</member>
<member name="M:RSG.Platform.FileTypeExtensions.CreateExtensionForPlatform(RSG.Platform.FileType,RSG.Platform.Platform)">
<summary>
Return the extension string for a platforms file type.
</summary>
<param name="value">
<see cref="T:RSG.Platform.FileType"/> value.
</param>
<param name="platform">
Platform to determine extension.
</param>
<returns>
File extension (excluding ".").
</returns>
</member>
<member name="T:RSG.Platform.FileTypeUtils">
<summary>
<see cref="T:RSG.Platform.FileType"/> enumeration utility methods.
</summary>
</member>
<member name="F:RSG.Platform.FileTypeUtils.ExtensionFileTypeMap">
<summary>
Used to cache results of calls to ConvertExtensionToFileType().
Calls to ConvertExtensionToFileType() should be O(log n) once this is populated.
</summary>
</member>
<member name="M:RSG.Platform.FileTypeUtils.ConvertExtensionToFileType(System.String)">
<summary>
Attempts to convert an extension to a file type
</summary>
<param name="extension">
File extension string (e.g. from <see cref="M:System.IO.Path.GetExtension(System.String)"/>.
</param>
<returns>
<see cref="T:RSG.Platform.FileType"/> value.
</returns>
</member>
<member name="T:RSG.Platform.GameBuildType">
<summary>
Enumeration to represent game build type (debug, beta etc).
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Beta">
<summary>
Beta build; most commonly run build with RAG support.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.BankRelease">
<summary>
BankRelease build; release build with RAG support.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Debug">
<summary>
Debug build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Release">
<summary>
Release build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Release_PGI">
<summary>
Release PGI build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Release_LTCG">
<summary>
Release LTCG build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.BankRelease_ASAN">
<summary>
BankRelease ASAN build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Release_ASAN">
<summary>
Release ASAN build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Final">
<summary>
Final build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Profile">
<summary>
Profile build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.Profile_LTCG">
<summary>
Profile LTCG build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.GameToolDebug">
<summary>
GameTool Debug build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.GameToolBeta">
<summary>
GameTool Beta build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.GameToolBankRelease">
<summary>
GameTool BankRelease build.
</summary>
</member>
<member name="F:RSG.Platform.GameBuildType.GameToolRelease">
<summary>
GameTool Release build.
</summary>
</member>
<member name="T:RSG.Platform.GameBuildTypeUtils">
<summary>
GameBuildType enumeration utility and extension methods.
</summary>
</member>
<member name="M:RSG.Platform.GameBuildTypeUtils.TryParseFromFilepath(System.String,RSG.Platform.GameBuildType@)">
<summary>
Tries to parse a path to find any BuildConfig value, returning whether the operation was successful
</summary>
<param name="path">
Input path string.
</param>
<param name="config">
<see cref="T:RSG.Platform.GameBuildType"/> found. Only use if method returns true.
</param>
<returns>
true if the string parse was successful; false otherwise.
</returns>
</member>
<member name="M:RSG.Platform.GameBuildTypeUtils.GetLiveEditCapable">
<summary>
Return Live Edit capable build types.
</summary>
<returns>
<see cref="T:System.Collections.Generic.IEnumerable`1"/> of Live Edit capable build types.
</returns>
</member>
<member name="T:RSG.Platform.Images.PlatformImageMonikerGuids">
<summary>
Reference to GUIDs and IDs that can be used by Monikers.
</summary>
<remarks>GUIDs and integer tuples so we avoid the reference to RSG.Editor.</remarks>
</member>
<member name="P:RSG.Platform.Images.PlatformImageMonikerGuids.PlatformWindows">
<summary>
Tuple with GUID and ID to use with an ImageMoniker for the Windows platform.
</summary>
</member>
<member name="T:RSG.Platform.IO.EndianBinaryReader">
<summary>
<see cref="T:System.IO.BinaryReader"/> subclass that uses an <see cref="T:RSG.Platform.Conversion.EndianBitConverter"/>
to read values for different endianness.
</summary>
</member>
<member name="F:RSG.Platform.IO.EndianBinaryReader._endianConverter">
<summary>
Endian bit converter object.
</summary>
</member>
<member name="F:RSG.Platform.IO.EndianBinaryReader._buffer">
<summary>
Buffer used for temporary storage before conversion into primitives
</summary>
</member>
<member name="F:RSG.Platform.IO.EndianBinaryReader._disposing">
<summary>
Local disposing flag.
</summary>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.#ctor(RSG.Platform.Conversion.EndianBitConverter,System.IO.Stream)">
<summary>
Constructor.
</summary>
<param name="converter"></param>
<param name="stream"></param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.#ctor(RSG.Platform.Conversion.EndianBitConverter,System.IO.Stream,System.Text.Encoding)">
<summary>
Constructor.
</summary>
<param name="converter"></param>
<param name="stream"></param>
<param name="encoding"></param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadBoolean">
<summary>
Reads a Boolean value from the current stream and advances the current position
of the stream by one byte.
</summary>
<returns>true if the byte is nonzero; otherwise, false.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadDecimal">
<summary>
Reads a decimal value from the current stream and advances the current position
of the stream by sixteen bytes.
</summary>
<returns>A decimal value read from the current stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadDouble">
<summary>
Reads an 8-byte floating point value from the current stream and advances
the current position of the stream by eight bytes.
</summary>
<returns>An 8-byte floating point value read from the current stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadInt16">
<summary>
Reads a 2-byte signed integer from the current stream and advances the current
position of the stream by two bytes.
</summary>
<returns>A 2-byte signed integer read from the current stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadInt32">
<summary>
Reads a 4-byte signed integer from the current stream and advances the current
position of the stream by four bytes.
</summary>
<returns>A 4-byte signed integer read from the current stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadInt64">
<summary>
Reads an 8-byte signed integer from the current stream and advances the current
position of the stream by eight bytes.
</summary>
<returns>An 8-byte signed integer read from the current stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadSingle">
<summary>
Reads a 4-byte floating point value from the current stream and advances
the current position of the stream by four bytes.
</summary>
<returns>A 4-byte floating point value read from the current stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadUInt16">
<summary>
Reads a 2-byte unsigned integer from the current stream using little-endian
encoding and advances the position of the stream by two bytes.
</summary>
<returns>A 2-byte unsigned integer read from this stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadUInt32">
<summary>
Reads a 4-byte unsigned integer from the current stream and advances the
position of the stream by four bytes.
</summary>
<returns>A 4-byte unsigned integer read from this stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadUInt64">
<summary>
Reads an 8-byte unsigned integer from the current stream and advances the
position of the stream by eight bytes.
</summary>
<returns>An 8-byte unsigned integer read from this stream.</returns>
<exception cref="T:System.IO.EndOfStreamException">The end of the stream is reached.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.Dispose(System.Boolean)">
<summary>
</summary>
<param name="disposing"></param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.CheckDisposed">
<summary>
</summary>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryReader.ReadInternal(System.Byte[],System.Int32)">
<summary>
Reads the given number of bytes from the stream, throwing an exception
if they can't all be read.
</summary>
<param name="data">Buffer to read into</param>
<param name="size">Number of bytes to read</param>
</member>
<member name="T:RSG.Platform.IO.EndianBinaryWriter">
<summary>
<see cref="T:System.IO.BinaryWriter"/> subclass that uses an <see cref="T:RSG.Platform.Conversion.EndianBitConverter"/>
to write values for different endianness.
</summary>
</member>
<member name="F:RSG.Platform.IO.EndianBinaryWriter._endianConverter">
<summary>
Endian bit converter object.
</summary>
</member>
<member name="F:RSG.Platform.IO.EndianBinaryWriter._buffer">
<summary>
Buffer used for temporary storage before conversion into primitives
</summary>
</member>
<member name="F:RSG.Platform.IO.EndianBinaryWriter._disposing">
<summary>
Local disposing flag.
</summary>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.#ctor(RSG.Platform.Conversion.EndianBitConverter)">
<summary>
Initialises a new instance of the <see cref="T:RSG.Platform.IO.EndianBinaryWriter"/> class
specifying an <see cref="T:RSG.Platform.Conversion.EndianBitConverter"/> to use.
</summary>
<param name="converter">
Endian converter to use.
</param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.#ctor(RSG.Platform.Conversion.EndianBitConverter,System.IO.Stream)">
<summary>
Initialises a new instance of the <see cref="T:RSG.Platform.IO.EndianBinaryWriter"/> class
specifying an <see cref="T:RSG.Platform.Conversion.EndianBitConverter"/> to use.
</summary>
<param name="converter">
Endian converter to use.
</param>
<param name="stream">
Stream to use.
</param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.#ctor(RSG.Platform.Conversion.EndianBitConverter,System.IO.Stream,System.Text.Encoding)">
<summary>
Initialises a new instance of the <see cref="T:RSG.Platform.IO.EndianBinaryWriter"/> class
specifying an <see cref="T:RSG.Platform.Conversion.EndianBitConverter"/> to use.
</summary>
<param name="converter">
Endian converter to use.
</param>
<param name="stream">
Stream to use.
</param>
<param name="encoding">
Character encoding to use.
</param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Boolean)">
<summary>
Writes a one-byte Boolean value to the current stream, with 0 representing
false and 1 representing true.
</summary>
<param name="value">The Boolean value to write (0 or 1).</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Decimal)">
<summary>
Writes a decimal value to the current stream and advances the stream position
by sixteen bytes.
</summary>
<param name="value">The decimal value to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Double)">
<summary>
Writes an eight-byte floating-point value to the current stream and advances
the stream position by eight bytes.
</summary>
<param name="value">The eight-byte floating-point value to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Single)">
<summary>
Writes a four-byte floating-point value to the current stream and advances
the stream position by four bytes.
</summary>
<param name="value">The four-byte floating-point value to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Int32)">
<summary>
Writes a four-byte signed integer to the current stream and advances the
stream position by four bytes.
</summary>
<param name="value">The four-byte signed integer to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Int64)">
<summary>
Writes an eight-byte signed integer to the current stream and advances the
stream position by eight bytes.
</summary>
<param name="value">The eight-byte signed integer to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.Int16)">
<summary>
Writes a two-byte signed integer to the current stream and advances the stream
position by two bytes.
</summary>
<param name="value">The two-byte signed integer to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.UInt32)">
<summary>
Writes a four-byte unsigned integer to the current stream and advances the
stream position by four bytes.
</summary>
<param name="value">The four-byte unsigned integer to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.UInt64)">
<summary>
Writes an eight-byte unsigned integer to the current stream and advances
the stream position by eight bytes.
</summary>
<param name="value">The eight-byte unsigned integer to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Write(System.UInt16)">
<summary>
Writes a two-byte unsigned integer to the current stream and advances the
stream position by two bytes.
</summary>
<param name="value">The two-byte unsigned integer to write.</param>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.Dispose(System.Boolean)">
<summary>
</summary>
<param name="disposing"></param>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.CheckDisposed">
<summary>
</summary>
</member>
<member name="M:RSG.Platform.IO.EndianBinaryWriter.WriteInternal(System.Byte[],System.Int32)">
<summary>
Writes the given number of bytes from the stream.
</summary>
<param name="data">Buffer to write from.</param>
<param name="size">Number of bytes to write.</param>
</member>
<member name="T:RSG.Platform.PlatformExtensions">
<summary>
<see cref="T:RSG.Platform.Platform"/> extension methods.
</summary>
<remarks>
This class now statically caches some of the compile-time attributes. This was
noted in some Asset Pipeline performance captures to be significant time because
of the number of assets and consequently the number of hits these methods take.
</remarks>
</member>
<member name="F:RSG.Platform.PlatformExtensions.PlatformRagebuilderPlatformCache">
<summary>
Field for caching the <see cref="T:RSG.Platform.Attributes.RagebuilderPlatformAttribute"/> attribute values.
Since these are defined by compile-time attributes we can cache them.
</summary>
</member>
<member name="F:RSG.Platform.PlatformExtensions.PlatformRagebuilderTextureTemplateExtensionCache">
<summary>
Field for caching the <see cref="T:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute"/> attributes values.
Since these are defined by compile-time attributes we can
cache them.
</summary>
</member>
<member name="F:RSG.Platform.PlatformExtensions.PlatformRagebuilderCharacterCache">
<summary>
Field for caching the <see cref="T:RSG.Platform.Attributes.PlatformExtensionCharacterAttribute"/> attribute values.
Since these are defined by compile-time attributes we can cache them.
</summary>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformIcon(RSG.Platform.Platform)">
<summary>
Return icon bitmap source for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
PLatform icon.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformToRagebuilderPlatform(RSG.Platform.Platform)">
<summary>
Return Ragebuilder Platform String for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
<see cref="T:System.String"/> representing the platform for Ragebuilder.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformToGamePlatform(RSG.Platform.Platform)">
<summary>
Return Game Platform String for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
String for game.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformRagebuilderTextureTemplate(RSG.Platform.Platform)">
<summary>
Return Ragebuilder Texture Template extensions attribute for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
Instance of <see cref="T:RSG.Platform.Attributes.RagebuilderTextureTemplateAttribute"/>.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformRagebuilderTextureTemplateExtension(RSG.Platform.Platform)">
<summary>
Return Ragebuilder Texture Template extension for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
Texture template extension.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformToVisualStudioPlatform(RSG.Platform.Platform)">
<summary>
Return Visual Studio Platform String for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
Visual Studio platform.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.Endianness(RSG.Platform.Platform)">
<summary>
Return platform endianness for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
Endianness of the platform.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.Is64BitArchitecture(RSG.Platform.Platform)">
<summary>
Return whether platform is 64-bit architecture.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
true if 64-bit architecture; false otherwise.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformToFriendlyName(RSG.Platform.Platform)">
<summary>
Return friendly name String for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
Friendly name for the <see cref="T:RSG.Platform.Platform"/>.
</returns>
</member>
<member name="M:RSG.Platform.PlatformExtensions.PlatformRagebuilderCharacter(RSG.Platform.Platform)">
<summary>
Return Platform Extension Character for a Platform enum value.
</summary>
<param name="platform">
<see cref="T:RSG.Platform.Platform"/> value.
</param>
<returns>
Character that indicates the Ragebuilder Platform.
</returns>
</member>
<member name="T:RSG.Platform.PlatformFeatures">
<summary>
Hardware feature flags. Way of tagging platforms that can support particular
features giving a finer grain of control over the PlatformGeneration enumeration.
</summary>
</member>
<member name="F:RSG.Platform.PlatformFeatures.None">
<summary>
No hardware features.
</summary>
</member>
<member name="F:RSG.Platform.PlatformFeatures.All">
<summary>
All hardware features.
</summary>
</member>
<member name="F:RSG.Platform.PlatformFeatures.Generation7Default">
<summary>
Seventh generation hardware default features.
</summary>
</member>
<member name="F:RSG.Platform.PlatformFeatures.Generation8Default">
<summary>
Eigth generation hardware default features.
</summary>
</member>
<member name="T:RSG.Platform.PlatformGeneration">
<summary>
Hardware generation enumeration. This could be used as a way of
marking features to support based on hardware-generations to
support generation transitions. Alternatively a hardware feature
flag enumeration may be required.
</summary>
</member>
<member name="F:RSG.Platform.PlatformGeneration.None">
<summary>
Unknown hardware generation.
</summary>
</member>
<member name="F:RSG.Platform.PlatformGeneration.Seventh">
<summary>
Seventh generation; Xbox 360, PS3 etc.
</summary>
</member>
<member name="F:RSG.Platform.PlatformGeneration.Eigth">
<summary>
Eigth generation; Xbox One, PS4 etc.
</summary>
</member>
<member name="T:RSG.Platform.FileType">
<summary>
Type of asset files.
</summary>
</member>
<member name="F:RSG.Platform.FileType.BoundsDictionary">
<summary>
Collision bounds dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.BoundsFile">
<summary>
Collision bounds file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Blendshape">
<summary>
Blendshape file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ClipDictionary">
<summary>
Clip dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.DrawableDictionary">
<summary>
Drawable dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Drawable">
<summary>
Drawable file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Fragment">
<summary>
Fragment file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.TextureDictionary">
<summary>
Texture dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ClothDictionary">
<summary>
Cloth dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.BlendshapeDictionary">
<summary>
Blendshape dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.VisualEffectDictionary">
<summary>
Visual effects dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ExpressionDictionary">
<summary>
Expression dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.FrameFilterDictionary">
<summary>
Frame filter dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Metadata">
<summary>
Metadata (parCodeGen) file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Manifest">
<summary>
RPF Manifest file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Cachefile">
<summary>
RPF Cache file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.PSO">
<summary>
PSO Metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ResourcedPsoMetadata">
<summary>
Resourced PSO Metadata file.
</summary>
This gets mapped to the same non-resoured variant because the runtime
streaming module can handle the different file types.
</member>
<member name="F:RSG.Platform.FileType.Script">
<summary>
SanScript file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ITYP">
<summary>
Map ITYP Metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.IMAP">
<summary>
Map IMAP Metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.TexturePipelineSpecification">
<summary>
Texture processing pipeline specification metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.TexturePipelineTemplate">
<summary>
Texture processing pipeline template metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.TexturePipelineTemplateLink">
<summary>
Texture processing pipeline link metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.RagePackFile">
<summary>
RPF.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ZipArchive">
<summary>
Zip file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.CutsceneMetadata">
<summary>
Cutscene metadata file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ExportBoundFile">
<summary>
Export bound file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.AnimFile">
<summary>
Animation file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ClipFile">
<summary>
Clip file (animation metadata).
</summary>
</member>
<member name="F:RSG.Platform.FileType.File">
<summary>
Generic file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.VehicleRecording">
<summary>
Vehicle recording file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.WaypointRecording">
<summary>
Waypoint recording file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.MaterialObject">
<summary>
Material Preset file for an object.
</summary>
</member>
<member name="F:RSG.Platform.FileType.MaterialSurface">
<summary>
Material Preset file for a surface.
</summary>
</member>
<member name="F:RSG.Platform.FileType.MaterialTemplate">
<summary>
Material Preset template file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.MaterialTemplateExport">
<summary>
Material Preset export file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.MotionTree">
<summary>
Motion tree file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.TetrahedronNode">
<summary>
Tetrahedron file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.TetrahedronElement">
<summary>
Tetrahedron file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.SceneLinkDictionary">
<summary>
Object (Scene?) Link Dictionary.
</summary>
</member>
<member name="F:RSG.Platform.FileType.MapExtensionDictionary">
<summary>
Map Extension dictionary file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Occlusion">
<summary>
Map occlusion file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.ProcessorParameterXML">
<summary>
Independent file type to resemble a parameter XML.
</summary>
</member>
<member name="F:RSG.Platform.FileType.SceneXML">
<summary>
SceneXml file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.FileList">
<summary>
File type to resemble a FileList.
</summary>
</member>
<member name="F:RSG.Platform.FileType.CSharpScriptObject">
<summary>
File type to CSharp Script Object.
</summary>
<remarks>
The odd Regex ranges are to ensure we don't pick up TCS for
texture template specification.
</remarks>
</member>
<member name="F:RSG.Platform.FileType.Texture">
<summary>
File type for textures.
</summary>
<remarks>
This is trying out specifying multiple <see cref="T:RSG.Platform.Attributes.FileTypeExtensionAttribute"/>
per file type value. Ensure you update the <see cref="T:RSG.Base.Attributes.RegexAttribute"/> too if
you add additional extensions.
</remarks>
</member>
<member name="F:RSG.Platform.FileType.Mesh">
<summary>
Mesh file.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Blacklist">
<summary>
Taint file from a blacklist export.
</summary>
</member>
<member name="F:RSG.Platform.FileType.Unknown">
<summary>
Unknown file type.
</summary>
</member>
<member name="T:RSG.Platform.Filename">
<summary>
Generic filename and path utility methods.
</summary>
</member>
<member name="F:RSG.Platform.Filename.AssetsNamespace">
<summary>
Assets namespace constant to avoid reference to framework RSG.Assets.Constants.
</summary>
</member>
<member name="F:RSG.Platform.Filename.DefaultGuidNumberOfFolderLevels">
<summary>
Default number of Guid characters to use for folder levels.
</summary>
</member>
<member name="M:RSG.Platform.Filename.GetBasename(System.String)">
<summary>
Return filename basename; stripping off all extensions.
</summary>
<param name="filename">
Input filename.
</param>
<returns>
Filename basename (no extensions).
</returns>
</member>
<member name="M:RSG.Platform.Filename.GetExtensions(System.String)">
<summary>
Return an array of string extensions; to determine file types.
</summary>
<param name="filename">Input filename.</param>
<returns>Array of String extensions.</returns>
E.g.
PathConversion.GetExtensions(@"x:\path\asset.idr.zip");
--> [ "zip", "idr" ]
</member>
<member name="M:RSG.Platform.Filename.GetFileTypes(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Return an array of FileType enum values; to determine file types.
</summary>
<param name="extensions">Array of extensions.</param>
<returns>
Array of <see cref="T:RSG.Platform.FileType"/> values indicating all file types.
</returns>
</member>
<member name="M:RSG.Platform.Filename.IsSubPath(System.String,System.String)">
<summary>
Goes through parents of a directory and compares to another
</summary>
<param name="path"></param>
<param name="root"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Filename.ComparePaths(System.String,System.String)">
<summary>
Whether two paths with potentiually different case and seperators are the same
</summary>
<param name="path1"></param>
<param name="path2"></param>
<returns></returns>
</member>
<member name="M:RSG.Platform.Filename.GetFileTypes(System.String)">
<summary>
Return an array of FileType enum values; to determine file types.
</summary>
<param name="filename">
Filename string to determine file type for.
</param>
<returns>
Array of <see cref="T:RSG.Platform.FileType"/> values indicating all file types.
</returns>
</member>
<member name="M:RSG.Platform.Filename.GameToPipelineFilename(System.String)">
<summary>
Takes a platform specific filename (common:/) and converts it into a
pipeline friendly path ($(build)/common/)
</summary>
<param name="gameFilename">
Game path.
</param>
<returns>
Local machine path.
</returns>
</member>
<member name="M:RSG.Platform.Filename.IsVaultAssetPath(System.String)">
<summary>
Return whether the passed in <see cref="T:System.String"/> is a Vault Asset path.
</summary>
<param name="path">
Path string to check.
</param>
<returns>
true if the path string is a valid Vault Asset; false otherwise.
</returns>
</member>
<member name="M:RSG.Platform.Filename.GetFullPaths(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Helper method that returns an enumerable of file and Vault Asset paths and
correctly expands the non-Asset Paths only.
</summary>
<param name="paths">
Input paths to expand correctly; based on whether they are files or vault assets.
</param>
<returns>
Enumerable of expanded paths.
</returns>
</member>
<member name="M:RSG.Platform.Filename.GetGuidPath(System.String,System.Guid,System.String,System.UInt32)">
<summary>
Get a directory path for a GUID where we use characters of the GUID
as subdirectories.
</summary>
<param name="rootPath"></param>
<param name="guid"></param>
<param name="extension">
File extension to append (should include ".").
</param>
<param name="numberOfFolderLevels">
Number of directory levels to use (default: 3).
</param>
<example>
Guid g = new Guid("5620b495-a21f-4d0c-972d-2eba736151d2");
String directory = Filename.GetGuidBasedDirectory(
@"x:\testfolder",
g);
// directory is now @"x:\testfolder\5\6\2\5620b495-a21f-4d0c-972d-2eba736151d2"
</example>
</member>
<member name="T:RSG.Platform.Platform">
<summary>
Platform enumeration.
</summary>
</member>
<member name="F:RSG.Platform.Platform.Independent">
<summary>
Independent platform (export data).
</summary>
</member>
<member name="F:RSG.Platform.Platform.Win32">
<summary>
Windows x86, 32-bit.
</summary>
</member>
<member name="F:RSG.Platform.Platform.Win64">
<summary>
Windows AMD64, 64-bit.
</summary>
</member>
<member name="F:RSG.Platform.Platform.PS3">
<summary>
Sony PlayStation 3.
</summary>
</member>
<member name="F:RSG.Platform.Platform.Xbox360">
<summary>
Microsoft Xbox 360.
</summary>
</member>
<member name="F:RSG.Platform.Platform.PS4">
<summary>
Sony PlayStation 4.
</summary>
</member>
<member name="F:RSG.Platform.Platform.XboxOne">
<summary>
Microsoft Xbox One.
</summary>
</member>
<member name="F:RSG.Platform.Platform.Android">
<summary>
Android platform.
</summary>
</member>
<member name="F:RSG.Platform.Platform.AppleIos">
<summary>
Apple iOS platform.
</summary>
</member>
<member name="F:RSG.Platform.Platform.PS4Pro">
<summary>
Sony PlayStation 4 Pro.
</summary>
</member>
<member name="F:RSG.Platform.Platform.XboxOneX">
<summary>
Microsoft Xbox One X (Scorpio).
</summary>
</member>
<member name="F:RSG.Platform.Platform.Linux">
<summary>
linux - generic linux platform, currently aimed at 64-bit LE architecture; if there's a need to support other types,
we'll need to account for it withing the code/data, or make a new platfom (eg, linux32).
</summary>
</member>
<member name="F:RSG.Platform.Platform.Yeti">
<summary>
Yeti - proprietary platform based on linux; will probably share existing x64 data/pipeline, but it's possible there will be exceptions in the future.
</summary>
</member>
<member name="F:RSG.Platform.Platform.NX64">
<summary>
NX64 - Nintendo Switch
</summary>
</member>
<member name="T:RSG.Platform.PlatformIcons">
<summary>
Provides static properties that give access to platform icons that can be used
throughout an application.
</summary>
</member>
<member name="F:RSG.Platform.PlatformIcons._playstation">
<summary>
The private field used for the <see cref="P:RSG.Platform.PlatformIcons.PS4"/> and <see cref="P:RSG.Platform.PlatformIcons.PS3"/> property.
</summary>
</member>
<member name="F:RSG.Platform.PlatformIcons._syncRoot">
<summary>
A generic object that provides thread safety access to the image sources.
</summary>
</member>
<member name="F:RSG.Platform.PlatformIcons._windows">
<summary>
The private field used for the <see cref="P:RSG.Platform.PlatformIcons.Win32"/> and <see cref="P:RSG.Platform.PlatformIcons.Win64"/>
property.
</summary>
</member>
<member name="F:RSG.Platform.PlatformIcons._xbox">
<summary>
The private field used for the <see cref="P:RSG.Platform.PlatformIcons.XboxOne"/> and <see cref="P:RSG.Platform.PlatformIcons.Xbox360"/>
property.
</summary>
</member>
<member name="F:RSG.Platform.PlatformIcons._android">
<summary>
The private field used for the <see cref="P:RSG.Platform.PlatformIcons.Android"/> property
property.
</summary>
</member>
<member name="F:RSG.Platform.PlatformIcons._ios">
<summary>
The private field used for the <see cref="P:RSG.Platform.PlatformIcons.AppleIos"/> property
property.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.PS3">
<summary>
Gets the icon that shows a symbol for the playstation 3 platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.PS4">
<summary>
Gets the icon that shows a symbol for the playsation 4 platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.Win32">
<summary>
Gets the icon that shows a symbol for the win32 platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.Win64">
<summary>
Gets the icon that shows a symbol for the win32 platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.Xbox360">
<summary>
Gets the icon that shows a symbol for the xbox 360 platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.XboxOne">
<summary>
Gets the icon that shows a symbol for the xbox one platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.Android">
<summary>
Gets the icon that shows a symbol for the android platform.
</summary>
</member>
<member name="P:RSG.Platform.PlatformIcons.AppleIos">
<summary>
Gets the icon that shows a symbol for the ios platform.
</summary>
</member>
<member name="M:RSG.Platform.PlatformIcons.EnsureLoaded(System.Windows.Media.Imaging.BitmapSource@,System.String)">
<summary>
Ensures that the specified image source is loaded with the specified resource name.
</summary>
<param name="source">
The image source that should be loaded.
</param>
<param name="resourceName">
The name of the resource the loaded image source should set as its source.
</param>
</member>
<member name="T:RSG.Platform.PlatformSDK">
<summary>
Helper for platform SDK parsing.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.VersionRegex">
<summary>
Regex to parse version numbers including decimals.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKFolder">
<summary>
Environment variable for the folder of the XDK files.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKFile">
<summary>
The local XDK version information file.
This seems to have been depreciated as of Nov 2015 XDK 10.0.10586.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKVersionDefPrefix">
<summary>
The prefix in the XDK version file for the version number.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKInfoExecutable">
<summary>
Path to the XDK info executable.
This is preferred as of Nov 2015 XDK 10.0.10586.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKInfoArguments">
<summary>
The arguments for the XDK executable.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKVersionPrefix">
<summary>
Prefix of the XDK version from the output of the XDK executable.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKEditionPrefix">
<summary>
Prefix of the XDK version from the output of the XDK executable.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.DurangoSDKEditionCutoff">
<summary>
Cutoff version for the XDK that determines whether or not to use Edition or Version format.
E.g if a number is &lt;, use Version format. &lt;= is Edition format.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.OrbisSDKFolder">
<summary>
Environment variable for the folder of the Orbis SDK files.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.OrbisHostToolsFolder">
<summary>
Environment variable for the folder of the Orbis SDK files.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.OrbisSDKExecutable">
<summary>
The local Orbis SDK version information file.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.OrbisSDKVersionPrefix">
<summary>
Prefix of the SDK version number output to parse.
</summary>
</member>
<member name="F:RSG.Platform.PlatformSDK.OrbisSCERootFolder">
<summary>
Environment variable for the folder of the SCE files.
</summary>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalOrbisSDKVersion">
<summary>
Attempts to parse the local orbis SDK version. Can throw exceptions.
</summary>
<returns>Null if version cannot be found.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.IsDurangoSDKEdition(System.String)">
<summary>
Checks if the input is a durango SDK edition or not.
</summary>
<param name="verToCheck"></param>
<returns>True if the input is an edition, false if it is a version number.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.IsOrbisRemoteViewerServerInstalled">
<summary>
Checks to see if the Orbis Remote Viewer Server is installed.
</summary>
<returns>True if the Remote Viewer Server lib is found.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalDurangoSDKVersion">
<summary>
Attempts to parse the local durango SDK version. Can throw IO exceptions.
</summary>
<returns>Null if version cannot be found.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalDurangoSDKEdition">
<summary>
Attempts to parse the output from the XDK executable for the SDK version.
Can throw IO and Process exceptions.
</summary>
<returns>Null if edition could not be found.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.IsSDKCompatible(System.String,System.String)">
<summary>
Compares 2 SDK version strings and returns if they can be used together.
E.g User is on 1.5, this can be used with a build that is for 1.4 but
1.4 can't be used on a build with 1.5
If SDK has names in it (eg Jan 2009 XDK), then an exact comparison is used.
</summary>
<param name="verToCheck"></param>
<param name="verToCompare"></param>
<returns>True if the first param is compatible with the second param.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.ExecuteCMD(System.String,System.String,System.Int32)">
<summary>
Executes shell command in a separate process.
Waits for Exit for specified time in milliseconds.
</summary>
<param name="cmd"></param>
<param name="args"></param>
<param name="timeoutMS"></param>
<returns>Standard console output</returns>
</member>
<member name="F:RSG.Platform.PlatformSDK.GetIpAddressDefaultTimeoutMs">
<summary>
Default Timeout in milliseconds for querying IP address
</summary>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalDurangoIPAddress">
<summary>
Attempts to get default IP address from connected XBOX1 DevKit.
</summary>
<returns>Null if IP address cannot be found.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalOrbisIPAddress">
<summary>
Attempts to get default IP address from connected PS4 DevKit.
</summary>
<returns>Null if IP address cannot be found.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalOrbisSDKFolder">
<summary>
Returns default SCE root folder.
</summary>
<returns>Folder</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalOrbisHostToolsFolder">
<summary>
Returns current SCE host_tools root folder.
</summary>
<returns>Folder</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.GetLocalDurangoSDKFolder">
<summary>
Returns default XDK root folder.
</summary>
<returns>Folder</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.ParseDurangoSDKInfo(System.String)">
<summary>
Attempts to read output from XDK info executable and parses out version strings.
Can throw IO and Process exceptions.
</summary>
<param name="prefix">Prefix format before the version number.</param>
<returns>Null if executable could not be found or output parsed.</returns>
</member>
<member name="M:RSG.Platform.PlatformSDK.ParseAdressIPv4(System.String)">
<summary>
Attempts to parse IPv4 address from arbitrary text.
Returns first IP address in the text.
</summary>
<param name="line">
Input string.
</param>
<returns>
<see cref="T:System.Net.IPAddress"/> if parse was successful; otherwise null.
</returns>
</member>
<member name="T:RSG.Platform.PlatformUtils">
<summary>
Platform enumeration utility and extension methods.
</summary>
</member>
<member name="M:RSG.Platform.PlatformUtils.RagebuilderPlatformToPlatform(System.String)">
<summary>
Return Platform enum value from a Ragebuilder platform string.
</summary>
<param name="ragebuilderPlatform">
Ragebuilder platform string.
</param>
<returns>
<see cref="T:RSG.Platform.Platform"/> for Ragebuilder platform.
</returns>
</member>
<member name="M:RSG.Platform.PlatformUtils.GamePlatformToPlatform(System.String)">
<summary>
Return Platform enum value from a game platform string.
</summary>
<param name="gamePlatform">
Game platform string.
</param>
<returns>
<see cref="T:RSG.Platform.Platform"/> for Ragebuilder platform.
</returns>
</member>
<member name="M:RSG.Platform.PlatformUtils.PlatformFromString(System.String)">
<summary>
Return Platform value from String representation.
</summary>
<param name="platform">Platform string.</param>
<returns>
<see cref="T:RSG.Platform.Platform"/> value for the string.
</returns>
</member>
<member name="M:RSG.Platform.PlatformUtils.PlatformFromFriendlyName(System.String)">
<summary>
Return Platform value from friendly name string representation.
</summary>
<param name="friendlyName">
Friendly name to convert.
</param>
<returns>
<see cref="T:RSG.Platform.Platform"/>.
</returns>
</member>
<member name="M:RSG.Platform.PlatformUtils.FilenameToPlatform(System.String)">
<summary>
Return Platform from an asset filename.
</summary>
<param name="filename">Asset filename</param>
<returns>Platform value</returns>
</member>
<member name="M:RSG.Platform.PlatformUtils.RpfFileNameToPlatform(System.String)">
<summary>
Return Platform from an RPF filename.
</summary>
<param name="fileName">RPF resource filename</param>
<returns>Platform value</returns>
</member>
<member name="T:RSG.Platform.ResourceCompressionType">
<summary>
Describes the type of compression used on resource files.
</summary>
</member>
<member name="F:RSG.Platform.ResourceCompressionType.None">
<summary>
No resource compression.
</summary>
</member>
<member name="F:RSG.Platform.ResourceCompressionType.Zlib">
<summary>
Zlib resource compression.
</summary>
</member>
<member name="F:RSG.Platform.ResourceCompressionType.OodleKraken">
<summary>
RAD Oodle/Kraken resource compression.
</summary>
</member>
<member name="F:RSG.Platform.ResourceCompressionType.Unknown">
<summary>
Unknown resource compression.
</summary>
</member>
<member name="T:RSG.Platform.TextureTemplateModifiers">
<summary>
Enum defining set of texture template modifiers that we can utilise that has Ragebuilder
support.
</summary>
</member>
<member name="F:RSG.Platform.TextureTemplateModifiers.None">
<summary>
No modifiers.
</summary>
</member>
<member name="F:RSG.Platform.TextureTemplateModifiers.UHD">
<summary>
Ultra-HD modifier (PS4 Pro, Scorpio, High-End PC). This defines a TCP template
named "{platform}hd.tcp" that would be picked up for Sparse Targets.
</summary>
</member>
</members>
</doc>
Reference in New Issue View Git Blame Copy Permalink