/Dlls/Delta.Utilities.TextureFormats.xml

  1<?xml version="1.0" encoding="utf-8"?>
  2<doc>
  3  <assembly>
  4    <name>Delta.Utilities.TextureFormats</name>
  5  </assembly>
  6  <members>
  7    <member name="T:Delta.Utilities.TextureFormats.DxtCompressionType">
  8      <summary>
  9            Type of DXT compressed data. For reference see:
 10            http://en.wikipedia.org/wiki/S3_Texture_Compression
 11            </summary>
 12    </member>
 13    <member name="T:Delta.Utilities.TextureFormats.DdsFile">
 14      <summary>
 15            Class for managing access to dds files.
 16            <para />
 17            General References:
 18            http://de.wikipedia.org/wiki/S3_Texture_Compression
 19            http://msdn.microsoft.com/en-us/library/bb943991%28VS.85%29.aspx
 20            <para />
 21            DdsHeader:
 22            http://msdn.microsoft.com/en-us/library/bb943982%28v=VS.85%29.aspx
 23            <para />
 24            DdsPixelFormat:
 25            http://msdn.microsoft.com/en-us/library/bb943984%28v=VS.85%29.aspx
 26            <para />
 27            Decoding:
 28            http://www.opengl.org/registry/specs/EXT/texture_compression_s3tc.txt
 29            </summary>
 30    </member>
 31    <member name="M:Delta.Utilities.TextureFormats.DdsFile.GetImageInfo(System.String)">
 32      <summary>
 33            Get the header information of a dds file.
 34            </summary>
 35    </member>
 36    <member name="M:Delta.Utilities.TextureFormats.DdsFile.GetCompressedData(System.String,System.Byte[]@)">
 37      <summary>
 38            Retrieve compressed image data from DXT compressed dds files. data will
 39            be allocated. Returns DdsInfo with width, height and compression type.
 40            </summary>
 41      <param name="relativeContentPath">File path to load from</param>
 42      <param name="data">Byte data array to load into</param>
 43      <returns>DdsInfo with all the details about this dds file</returns>
 44    </member>
 45    <member name="M:Delta.Utilities.TextureFormats.DdsFile.GetUnCompressedData(System.String,Delta.Utilities.TextureFormats.DdsFile.DdsInfo@,System.Byte[]@,System.Int32)">
 46      <summary>
 47            Retrieve uncompressed image data.
 48            imageInfo will contain width/height and compression type.
 49            data will be allocated if supplied array is too small.
 50            </summary>
 51    </member>
 52    <member name="T:Delta.Utilities.TextureFormats.DdsFile.PixelFormatFlags">
 53      <summary>
 54            Dds pixel format flags
 55            </summary>
 56    </member>
 57    <member name="T:Delta.Utilities.TextureFormats.DdsFile.DdsInfo">
 58      <summary>
 59            Dds info structure. This contains information which may be needed
 60            after loading. We do not want to pass the complete DdsHeader and
 61            Pixel format back.
 62            </summary>
 63    </member>
 64    <member name="T:Delta.Utilities.TextureFormats.PvrFile">
 65      <summary>
 66            Image data loader for loading the Pvr files generated by the Content
 67            System. This code does not handle all pvr files, it only supports the
 68            settings used in Generator (2bpp, 4bpp, and no flip).
 69            <para />
 70            For more PVR information check out:
 71            http://www.imgtec.com/powervr/insider/powervr-pvrtextool.asp and
 72            http://developer.apple.com/iphone/library/samplecode/PVRTextureLoader/listing8.html
 73            and the PVRTexTool.Reference Manual.1.15f.External.pdf
 74            </summary>
 75    </member>
 76    <member name="M:Delta.Utilities.TextureFormats.PvrFile.LoadPvrImage(System.String,System.Boolean,System.Boolean,Delta.Utilities.Datatypes.Size@,System.Byte[]@,System.Int32@,System.Int32@)">
 77      <summary>
 78            Load pvr image. Please note that only the OGL4444, the OGL5551
 79            and the PVRTC4/2 formats are supported and they only work in the
 80            way the GeneratePvr method in the ContentServer saves them
 81            (with the exact settings).
 82            </summary>
 83      <param name="relativeContentPath">The relative content path for the
 84            content image file we want to load</param>
 85      <param name="loadRgba4">Load our own Rgba4 format?</param>
 86      <param name="loadRgb5A1">Load our own Rgb5a1 format?</param>
 87      <param name="imageSize">Size of the image.</param>
 88      <param name="data">The data.</param>
 89      <param name="numMipmaps">The num mipmaps.</param>
 90      <param name="firstMipmapByteLength">First mipmap byte length</param>
 91    </member>
 92    <member name="T:Delta.Utilities.TextureFormats.PreciseColor">
 93      <summary>
 94            Precise color is a color which uses an integer as internal storage PER
 95            component. This allows for easy calculations without fear of overflows
 96            while doing computations. Example calculation: c1 * 2 / 3
 97            This simple calculation fails with standard implementations because 
 98            first *2 causes data loss for color values above 127.
 99            You need to make sure the values are clamped after calculations yourself.
100            (Or use the clamped accessors RedByte/GreenByte/BlueByte)
101            </summary>
102    </member>
103    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Red">
104      <summary>
105            Red value in range 0..255 (but may break bounds during calculation)
106            </summary>
107    </member>
108    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Green">
109      <summary>
110            Green value in range 0..255 (but may break bounds during calculation)
111            </summary>
112    </member>
113    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Blue">
114      <summary>
115            Blue value in range 0..255 (but may break bounds during calculation)
116            </summary>
117    </member>
118    <member name="F:Delta.Utilities.TextureFormats.PreciseColor.Alpha">
119      <summary>
120            Alpha value in range 0..255 (but may break bounds during calculation)
121            </summary>
122    </member>
123    <member name="M:Delta.Utilities.TextureFormats.PreciseColor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
124      <summary>
125            Create precise color with given color components
126            </summary>
127    </member>
128    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.RedByte">
129      <summary>
130            Red clamped to 0-255
131            </summary>
132    </member>
133    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.GreenByte">
134      <summary>
135            Green clamped to 0-255
136            </summary>
137    </member>
138    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.BlueByte">
139      <summary>
140            Blue clamped to 0-255
141            </summary>
142    </member>
143    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.AlphaByte">
144      <summary>
145            Alpha clamped to 0-255
146            </summary>
147    </member>
148    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.PackedRGBA">
149      <summary>
150            Packed RGBA
151            </summary>
152    </member>
153    <member name="P:Delta.Utilities.TextureFormats.PreciseColor.PackedBGRA">
154      <summary>
155            Packed BGRA
156            </summary>
157    </member>
158  </members>
159</doc>