Share via

IOverlay::GetDefaultColorKey (Compact 2013)

  • Article

3/26/2014

This method retrieves the default color key used for a chroma key overlay.

Syntax

HRESULT GetDefaultColorKey(
  COLORKEY* pColorKey
);

Parameters

  • pColorKey
    [out] Pointer to the COLORKEY structure that the default color key is copied to.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

Value

Description

E_FAIL

Failure.

E_POINTER

Null pointer argument.

E_INVALIDARG

Invalid argument.

E_NOTIMPL

Method is not supported.

S_OK or NOERROR

Success.

Remarks

A filter using color keys can get a default color from the video renderer. The default color key can then be installed into the window using IOverlay::SetColorKey.

The colors returned through this method depend on the current display mode.

  • If the colors are 8-bit palettized, they will be bright system colors (such as magenta).
  • If the display is in a true-color mode, they will be shades of black.

The IOverlay interface ensures that separate instances of the renderer on the same computer get different color keys so that overlays do not conflict.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IOverlay Interface