ID3D11ImageContext::JpegDecode method

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

Decodes a JPEG image.

Syntax

void JpegDecode(
  [in]            const D3D11_JPEG_DECODE_PARAMETERS *pParameters,
  [in]            ID3D11Resource *pDestination,
  [in, optional]  const UINT *pDestinationSubresources,
  [in, optional]  const D3D11_BOX *pDestinationBoxes,
  UINT NumDestinations,
  [in]            ID3D11Buffer *pScanData,
  UINT ScanDataOffset,
  UINT CopyFlags
);

Parameters

• pParameters [in]
  Type: const D3D11_JPEG_DECODE_PARAMETERS*

  A pointer to a D3D11_JPEG_DECODE_PARAMETERS structure that describes the decode parameters.

• pDestination [in]
  Type: ID3D11Resource*

  Pointer to a ID3D11Resource that represents the destination for the decoded image.

• pDestinationSubresources [in, optional]
  Type: const UINT*

  An array of zero-based indexes for the destination subresources.

• pDestinationBoxes [in, optional]
  Type: const D3D11_BOX*

  An array of boxes that define the portions of the destination subresources to copy the resource data into. Coordinates are in bytes for buffers and in texels for textures. If NULL, JpegDecode writes the data to the destination subresource with no offset. The dimensions of the source must fit the destination.

  An empty box results in a no-op. A box is empty if the top value is greater than or equal to the bottom value, or the left value is greater than or equal to the right value, or the front value is greater than or equal to the back value. When the box is empty, JpegDecode doesn't perform a decode operation.

• NumDestinations
  Type: UINT

  The number of destination subresources.

• pScanData [in]
  Type: ID3D11Buffer*

  A pointer to a ID3D11Buffer interface for the scan data for the image to decode.

• ScanDataOffset
  Type: UINT

  A zero-based offset into the scan data.

• CopyFlags
  Type: UINT

  A combination of copy values that are combined by using a bitwise OR operation.

Return value

This method does not return a value.

Requirements

See also

ID3D11ImageContext