ID2D1DeviceContext::CreateColorContextFromFilename method (d2d1_1.h)

Article
02/22/2024

Creates a color context by loading it from the specified filename. The profile bytes are the contents of the file specified by Filename.

Syntax

HRESULT CreateColorContextFromFilename(
        PCWSTR            filename,
  [out] ID2D1ColorContext **colorContext
);

Parameters

filename

Type: PCWSTR

The path to the file containing the profile bytes to initialize the color context with.

[out] colorContext

Type: ID2D1ColorContext**

When this method returns, contains the address of a pointer to a new color context.

Return value

Type: HRESULT

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

HRESULT	Description
S_OK	No error occurred.
E_OUTOFMEMORY	Direct2D could not allocate sufficient memory to complete the call.
E_INVALIDARG	An invalid value was passed to the method.

Remarks

The new color context can be used in D2D1_BITMAP_PROPERTIES1 to initialize the color context of a created bitmap. The model field of the profile header is inspected to determine whether this profile is sRGB or scRGB and the color space is updated respectively. Otherwise the space is custom.

Requirements

Requirement	Value
Minimum supported client	Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	d2d1_1.h
DLL	D2d1.dll