/Dlls/Delta.Utilities.TextureFormats.xml

<?xml version="1.0" encoding="utf-8"?>

<doc>

  <assembly>

    <name>Delta.Utilities.TextureFormats</name>

  </assembly>

  <members>

    <member name="T:Delta.Utilities.TextureFormats.DxtCompressionType">

      <summary>

            Type of DXT compressed data. For reference see:

            http://en.wikipedia.org/wiki/S3_Texture_Compression

            </summary>

    </member>

    <member name="T:Delta.Utilities.TextureFormats.DdsFile">

      <summary>

            Class for managing access to dds files.

            <para />

            General References:

            http://de.wikipedia.org/wiki/S3_Texture_Compression

            http://msdn.microsoft.com/en-us/library/bb943991%28VS.85%29.aspx

            <para />

            DdsHeader:

            http://msdn.microsoft.com/en-us/library/bb943982%28v=VS.85%29.aspx

            <para />

            DdsPixelFormat:

            http://msdn.microsoft.com/en-us/library/bb943984%28v=VS.85%29.aspx

            <para />

            Decoding:

            http://www.opengl.org/registry/specs/EXT/texture_compression_s3tc.txt

            </summary>

    </member>

    <member name="M:Delta.Utilities.TextureFormats.DdsFile.GetImageInfo(System.String)">

      <summary>

            Get the header information of a dds file.

            </summary>

    </member>

    <member name="M:Delta.Utilities.TextureFormats.DdsFile.GetCompressedData(System.String,System.Byte[]@)">

      <summary>

            Retrieve compressed image data from DXT compressed dds files. data will

            be allocated. Returns DdsInfo with width, height and compression type.

            </summary>

      <param name="relativeContentPath">File path to load from</param>

      <param name="data">Byte data array to load into</param>

      <returns>DdsInfo with all the details about this dds file</returns>

    </member>

    <member name="M:Delta.Utilities.TextureFormats.DdsFile.GetUnCompressedData(System.String,Delta.Utilities.TextureFormats.DdsFile.DdsInfo@,System.Byte[]@,System.Int32)">

      <summary>

            Retrieve uncompressed image data.

            imageInfo will contain width/height and compression type.

            data will be allocated if supplied array is too small.

            </summary>

    </member>

    <member name="T:Delta.Utilities.TextureFormats.DdsFile.PixelFormatFlags">

      <summary>

            Dds pixel format flags

            </summary>

    </member>

    <member name="T:Delta.Utilities.TextureFormats.DdsFile.DdsInfo">

      <summary>

            Dds info structure. This contains information which may be needed

            after loading. We do not want to pass the complete DdsHeader and

            Pixel format back.

            </summary>

    </member>

    <member name="T:Delta.Utilities.TextureFormats.PvrFile">

      <summary>

            Image data loader for loading the Pvr files generated by the Content

            System. This code does not handle all pvr files, it only supports the

            settings used in Generator (2bpp, 4bpp, and no flip).

            <para />

            For more PVR information check out:

            http://www.imgtec.com/powervr/insider/powervr-pvrtextool.asp and

            http://developer.apple.com/iphone/library/samplecode/PVRTextureLoader/listing8.html

            and the PVRTexTool.Reference Manual.1.15f.External.pdf

            </summary>

    </member>

    <member name="M:Delta.Utilities.TextureFormats.PvrFile.LoadPvrImage(System.String,System.Boolean,System.Boolean,Delta.Utilities.Datatypes.Size@,System.Byte[]@,System.Int32@,System.Int32@)">

      <summary>

            Load pvr image. Please note that only the OGL4444, the OGL5551

            and the PVRTC4/2 formats are supported and they only work in the

            way the GeneratePvr method in the ContentServer saves them

            (with the exact settings).

            </summary>

      <param name="relativeContentPath">The relative content path for the

            content image file we want to load</param>

      <param name="loadRgba4">Load our own Rgba4 format?</param>

      <param name="loadRgb5A1">Load our own Rgb5a1 format?</param>

      <param name="imageSize">Size of the image.</param>

      <param name="data">The data.</param>

      <param name="numMipmaps">The num mipmaps.</param>

      <param name="firstMipmapByteLength">First mipmap byte length</param>

    </member>

    <member name="T:Delta.Utilities.TextureFormats.PreciseColor">

      <summary>

            Precise color is a color which uses an integer as internal storage PER

            component. This allows for easy calculations without fear of overflows

            while doing computations. Example calculation: c1 * 2 / 3

            This simple calculation fails with standard implementations because 

            first *2 causes data loss for color values above 127.

            You need to make sure the values are clamped after calculations yourself.

            (Or use the clamped accessors RedByte/GreenByte/BlueByte)

            </summary>

    </member>

    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Red">

      <summary>

            Red value in range 0..255 (but may break bounds during calculation)

            </summary>

    </member>

    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Green">

      <summary>

            Green value in range 0..255 (but may break bounds during calculation)

            </summary>

    </member>

    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Blue">

      <summary>

            Blue value in range 0..255 (but may break bounds during calculation)

            </summary>

    </member>

    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Alpha">

      <summary>

            Alpha value in range 0..255 (but may break bounds during calculation)

            </summary>

    </member>

    <member name="M:Delta.Utilities.TextureFormats.PreciseColor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">

      <summary>

            Create precise color with given color components

            </summary>

    </member>

    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.RedByte">

      <summary>

            Red clamped to 0-255

            </summary>

    </member>

    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.GreenByte">

      <summary>

            Green clamped to 0-255

            </summary>

    </member>

    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.BlueByte">

      <summary>

            Blue clamped to 0-255

            </summary>

    </member>

    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.AlphaByte">

      <summary>

            Alpha clamped to 0-255

            </summary>

    </member>

    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.PackedRGBA">

      <summary>

            Packed RGBA

            </summary>

    </member>

    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.PackedBGRA">

      <summary>

            Packed BGRA

            </summary>

    </member>

  </members>

</doc>