Microsoft DirectX 8.1 (Visual Basic)

D3DX8.CreateCubeTextureFromFileEx

Creates a cube texture from a file. This is a more advanced method than D3DX8.CreateCubeTextureFromFile.

object.CreateCubeTextureFromFileEx( _ 
    Device As Direct3DDevice8, _ 
    SrcFile As String, _ 
    TextureSize As Long, _ 
    MipLevels As Long, _ 
    Usage As Long, _ 
    Format As CONST_D3DFORMAT, _ 
    Pool As CONST_D3DPOOL, _ 
    Filter As Long, _ 
    MipFilter As Long, _ 
    ColorKey As Long, _ 
    SrcInfo As Any, _ 
    Palette As Any) As Direct3DCubeTexture8

Parameters

object: Object expression that resolves to a D3DX8 object.
Device: Direct3DDevice8 object representing the device to be associated with the cube texture.
SrcFile: String that specifies the file from which to create the cube texture. See Remarks
TextureSize: Width and height of the cube texture, in pixels. So, if the cube texture is an 8 pixel by 8 pixel cube, the value for this parameter should be 8. Note that this value must be nonzero. If this value is 0 or D3DX_DEFAULT, the dimensions are taken from the file.
MipLevels: Number of mip levels requested. If this value is zero or D3DX_DEFAULT as defined by the CONST_D3DXENUM enumeration, a complete mipmap chain is created.
Usage: 0 or the D3DUSAGE_RENDERTARGET member of the CONST_D3DUSAGEFLAGS enumeration. Specifying D3DUSAGE_RENDERTARGET indicates that the surface is to be used as a render target. The resource can be passed to the NewRenderTarget parameter of the SetRenderTarget method. If D3DUSAGE_RENDERTARGET is specified, the application should check that the device supports this operation by calling Direct3D8.CheckDeviceFormat.
Format: Member of the CONST_D3DFORMAT enumeration, describing the requested pixel format for the cube texture. The returned cube texture might have a format different from that specified by Format. Applications should check the format of the returned cube texture. If Format is D3DFMT_UNKNOWN, the format is taken from the file.
Pool: Member of the CONST_D3DPOOL enumeration, describing the memory class into which the cube texture should be placed.
Filter: A combination of one or more filter flags defined by the CONST_D3DXENUM enumeration, controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying D3DX_FILTER_DITHER Or D3DX_FILTER_TRIANGLE.
MipFilter: A combination of one or more mip filter flags defined by the CONST_D3DXENUM enumeration, controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying D3DX_FILTER_BOX.
ColorKey: Value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque colorkeys. Thus, for opaque black, the value would be equal to &HFF000000.
SrcInfo: A D3DXIMAGE_INFO structure to be filled in with a description of the data in the source image file, or ByVal 0.
Palette: Object representing a 256-color palette to fill in, or Nothing.

Return Values

Direct3DCubeTexture8 object representing the created cube texture.

Error Codes

If the method fails, an error is raised and Err.Number can be set to one of the following values.

D3DERR_INVALIDCALL

D3DERR_NOTAVAILABLE

D3DERR_OUTOFVIDEOMEMORY

D3DXERR_INVALIDDATA

E_OUTOFMEMORY

For information on trapping errors, see the Microsoft® Visual Basic® Error Handling topic.

Remarks

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

CreateCubeTextureFromFileEx uses the DirectDrawSurface (DDS) file format. The DXTex Tool enables you to generate a cube map from other file formats and save it in the DDS file format.