Compress (const Image*, size_t, const TexMetadata&, DXGI_FORMAT, DWORD, float, ScratchImage&)

Compresses one or more images to a block compression (BC) format.

Syntax

HRESULT Compress(
         const Image *srcImages,
         size_t nimages,
         const TexMetadata &metadata,
         DXGI_FORMAT format,
         DWORD compress,
         float alphaRef,
         ScratchImage &cImages
)  

Parameters

srcImages
Type: Image *

[in] Pointer to one or more Image structures in a memory buffer.

nimages
Type: size_t 

[in] Number of images.

metadata
Type: TexMetadata 

[in] Address of a TexMetadata structure.

format
Type: DXGI_FORMAT 

[in] One member of the DXGI_FORMAT enumeration.

compress
Type: DWORD 

[in] One or more flags from the TEX_COMPRESS_FLAGS enumeration.

alphaRef
Type: float 

[in] Reference alpha value, only used by BC1 for supporting conversions to 1-bit transparency.

cImages
Type: ScratchImage 

[out] Pointer to a ScratchImage class instance.

Return value

Type: HRESULT 

Success or error code.

Requirements

Header: Declared in directxtex.h.