Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 2.6 KB

idxtkey-get-rgb.md

File metadata and controls

96 lines (58 loc) · 2.6 KB
description ms.assetid title ms.topic ms.date topic_type api_name api_type api_location ms.custom
The get\_RGB method retrieves the RGB color on which to key. This property applies only when the key type is DXTKEY\_RGB.
7b1b22ff-457a-48c8-9221-ca38601874a9
IDxtKey::get_RGB method (Qedit.h)
reference
4/26/2023
APIRef
kbSyntax
IDxtKey.get_RGB
COM
strmiids.lib
strmiids.dll
UpdateFrequency5

IDxtKey::get_RGB method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note

[Deprecated. This API may be removed from future releases of Windows.]

 

The get_RGB method retrieves the RGB color on which to key. This property applies only when the key type is DXTKEY_RGB.

Syntax

HRESULT get_RGB(
  [out, retval] DWORD *pVal
);

Parameters

pVal [out, retval]

Receives the color. The returned value is a hexadecimal number with the format 0xRRGGBB, where RR is the red value, GG is the green value, and BB is the blue value.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Note

The header file Qedit.h is not compatible with Direct3D headers later than version 7.

 

Note

To obtain Qedit.h, download the Microsoft Windows SDK Update for Windows Vista and .NET Framework 3.0. Qedit.h is not available in the Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1.

 

Requirements

Requirement Value
Header
Qedit.h
Library
Strmiids.lib

See also

IDxtKey Interface

IDxtKey::get_KeyType