Imaginary Game Engine API documentation
DDSImage Class
NamespacesIGEDDSImage

[This is preliminary documentation and is subject to change.]

Direct Draw Surface (.dds) image loader
Declaration Syntax
C#Visual BasicVisual C++
public class DDSImage : ImageFile
Public Class DDSImage _
	Inherits ImageFile
public ref class DDSImage : public ImageFile
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
DDSImage(Engine, String)
Constructor

BPP
Get bytes per pixel in image data
(Inherited from ImageFile.)
bytesPerPixel
Bytes stored per pixel
(Inherited from ImageFile.)
CloseStreams(Stream, Object)
Close filestream(s)
(Inherited from ReadFile.)
data
Image data
(Inherited from ImageFile.)
DecodeDXT(array<Byte>[]()[], Int32, Size, PixelFormat)
DXT compressed texture decoder

engine
Engine used to search the file
(Inherited from ReadFile.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
file
Path requested
(Inherited from ReadFile.)
FileName
Get the name of the file
(Inherited from ReadFile.)
filesize
Size of the file
(Inherited from ReadFile.)
Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Format
Get format of the image data
(Inherited from ImageFile.)
FullPath
Get the full path to the file
(Inherited from ReadFile.)
GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsOpen
Get true if the file is opened
(Inherited from ReadFile.)
Load(Stream, Object)
Load file asynchronously
(Overrides ImageFile.Load(Stream, Object).)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MipMapCount
Get the amount of mipmaps (1 is not mipmapped)
(Inherited from ImageFile.)
numMipMaps
Number of mipmaps
(Inherited from ImageFile.)
pFullPath
Full path to the file
(Inherited from ReadFile.)
pixelFormat
Format of image data
(Inherited from ImageFile.)
pSize
Image size (px)
(Inherited from ImageFile.)
RawData
Get image data
(Inherited from ImageFile.)
Size
Get image size (px)
(Inherited from ImageFile.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
WaitUntilOpen()()()
Wait method, call before allowing any access to the file to make sure the file has been opened.
(Inherited from ReadFile.)
Inheritance Hierarchy

Assembly: IGE Core (Module: IGE Core) Version: 0.1.2957.39562 (0.1.0.0)