TextureLoader.FromCubeFile Method

Language:

Creates a cube texture from a file.

Definition

Visual Basic Public Shared Function FromCubeFile( _
    ByVal device As Device, _
    ByVal srcFile As String _
) As CubeTexture

C# public static CubeTexture FromCubeFile(
    Device device,
    string srcFile
);

C++ public:
static CubeTexture^ FromCubeFile(
    Device^ device,
    String^ srcFile
);

JScript public static function FromCubeFile(
    device : Device,
    srcFile : String
) : CubeTexture;

Visual Basic	Public Shared Function FromCubeFile( _ ByVal device As Device, _ ByVal srcFile As String _ ) As CubeTexture
C#	public static CubeTexture FromCubeFile( Device device, string srcFile );
C++	public: static CubeTexture^ FromCubeFile( Device^ device, String^ srcFile );
JScript	public static function FromCubeFile( device : Device, srcFile : String ) : CubeTexture;

Parameters

device Microsoft.DirectX.Direct3D.Device
A Device object that represents the device to associate with the cube texture.

srcFile System.String
String that specifies the file name.

Return Value

Microsoft.DirectX.Direct3D.CubeTexture
A CubeTexture object that represents the created cube texture object.

Remarks

This method supports the following file formats: .bmp, .dds, .dib, .hdr, .jpg, .pfm, .png, .ppm, and .tga.

Cube textures differ from other surfaces in that they are collections of surfaces. To call Device.SetRenderTarget with a cube texture, select an individual face using CubeTexture.GetCubeMapSurface and pass the resulting surface to Device.SetRenderTarget.

The TextureLoader.FromCubeFile method uses the Microsoft DirectDraw surface (DDS) file format. The DXTex tool enables generation of a cube map from other file formats, and saves it as a .dds file.

Exceptions

InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.

InvalidDataException The data is invalid.

NotAvailableException This device does not support the queried technique.

OutOfVideoMemoryException Microsoft Direct3D does not have enough display memory to perform the operation.

OutOfMemoryException Direct3D could not allocate sufficient memory to complete the call.

device	Microsoft.DirectX.Direct3D.Device A Device object that represents the device to associate with the cube texture.
srcFile	System.String String that specifies the file name.

InvalidCallException	The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException	The data is invalid.
NotAvailableException	This device does not support the queried technique.
OutOfVideoMemoryException	Microsoft Direct3D does not have enough display memory to perform the operation.
OutOfMemoryException	Direct3D could not allocate sufficient memory to complete the call.