ID2D1DeviceContext::GetImageWorldBounds method

Gets the world bounds of an image.

Syntax


HRESULT GetImageWorldBounds(
  [in]   ID2D1Image *image,
  [out]  D2D1_RECT_F worldBounds[1]
);

Parameters

image [in]

Type: ID2D1Image*

The image whose bounds will be calculated.

worldBounds [out]

Type: D2D1_RECT_F[1]

When this method returns, contains a pointer to the bounds of the image in device independent pixels (DIPs).

Return value

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

HRESULTDescription
S_OKNo error occurred.
E_OUTOFMEMORYDirect2D could not allocate sufficient memory to complete the call.
E_INVALIDARGAn invalid parameter was passed to the returning function.

 

Remarks

The image bounds reflect the current DPI, unit mode, and world transform of the context. To get bounds which don't include the world transform, use ID2D1DeviceContext::GetImageLocalBounds.

The returned bounds reflect which pixels would be impacted by calling DrawImage with the same image and a target offset of (0,0). They do not reflect the current clip rectangle set on the device context or the extent of the context’s current target image.

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1_1.h

DLL

D2d1.dll

See also

ID2D1DeviceContext
ID2D1Image
ID2D1DeviceContext::CreateBitmap
D2D1_RECT_F
ID2D1DeviceContext::GetImageLocalBounds

 

 

Community Additions

ADD
Show:
© 2014 Microsoft