D2D1_MAP_OPTIONS enumeration

Specifies how the memory to be mapped from the corresponding ID2D1Bitmap1 should be treated.

Syntax


typedef enum  { 
  D2D1_MAP_OPTIONS_READ     = 1,
  D2D1_MAP_OPTIONS_WRITE    = 2,
  D2D1_MAP_OPTIONS_DISCARD  = 4
} D2D1_MAP_OPTIONS;

Constants

D2D1_MAP_OPTIONS_READ

Allow CPU Read access.

D2D1_MAP_OPTIONS_WRITE

Allow CPU Write access.

D2D1_MAP_OPTIONS_DISCARD

Discard the previous contents of the resource when it is mapped.

Remarks

The D2D1_MAP_OPTIONS_READ option can be used only if the bitmap was created with the D2D1_BITMAP_OPTIONS_CPU_READ flag.

These flags will be not be able to be used on bitmaps created by the ID2D1DeviceContext. However, the ID2D1SourceTransform will receive bitmaps for which these flags are valid.

D2D1_MAP_OPTIONS_DISCARD can only be used with D2D1_MAP_OPTIONS_WRITE. Both of these options are only available through the effect author API, not through the Direct2D rendering API.

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

See also

ID2D1Bitmap1::Map

 

 

Show: