Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 4.06 KB

nf-wingdi-wgldescribelayerplane.md

File metadata and controls

109 lines (72 loc) · 4.06 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:wingdi.wglDescribeLayerPlane
wglDescribeLayerPlane function (wingdi.h)
The wglDescribeLayerPlane function obtains information about the layer planes of a given pixel format.
_ogl_wglDescribeLayerPlane
opengl.wgldescribelayerplane
wglDescribeLayerPlane
wglDescribeLayerPlane function [OpenGL]
wingdi/wglDescribeLayerPlane
opengl\wgldescribelayerplane.htm
OpenGL
a80d257e-7053-4328-8298-80ed72513837
12/05/2018
_ogl_wglDescribeLayerPlane, opengl.wgldescribelayerplane, wglDescribeLayerPlane, wglDescribeLayerPlane function [OpenGL], wingdi/wglDescribeLayerPlane
wingdi.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Opengl32.lib
Opengl32.dll
Windows
19H1
wglDescribeLayerPlane
wingdi/wglDescribeLayerPlane
c++
APIRef
kbSyntax
DllExport
opengl32.dll
wglDescribeLayerPlane

wglDescribeLayerPlane function

-description

The wglDescribeLayerPlane function obtains information about the layer planes of a given pixel format.

-parameters

-param unnamedParam1

Specifies the device context of a window whose layer planes are to be described.

-param unnamedParam2

Specifies which layer planes of a pixel format are being described.

-param unnamedParam3

Specifies the overlay or underlay plane. Positive values of iLayerPlane identify overlay planes, where 1 is the first overlay plane over the main plane, 2 is the second overlay plane over the first overlay plane, and so on. Negative values identify underlay planes, where 1 is the first underlay plane under the main plane, 2 is the second underlay plane under the first underlay plane, and so on. The number of overlay and underlay planes is given in the bReserved member of the PIXELFORMATDESCRIPTOR structure.

-param unnamedParam4

Specifies the size, in bytes, of the structure pointed to by plpd. The wglDescribeLayerPlane function stores layer plane data in a LAYERPLANEDESCRIPTOR structure, and stores no more than nBytes of data. Set the value of nBytes to the size of LAYERPLANEDESCRIPTOR.

-param unnamedParam5

Points to a LAYERPLANEDESCRIPTOR structure. The wglDescribeLayerPlane function sets the value of the structure's data members. The function stores the number of bytes of data copied to the structure in the nSize member.

-returns

If the function succeeds, the return value is TRUE. In addition, the wglDescribeLayerPlane function sets the members of the LAYERPLANEDESCRIPTOR structure pointed to by plpd according to the specified layer plane (iLayerPlane ) of the specified pixel format (iPixelFormat ).

If the function fails, the return value is FALSE.

-remarks

The numbering of planes (iLayerPlane ) determines their order. Higher-numbered planes overlay lower-numbered planes.

-see-also

DescribePixelFormat

LAYERPLANEDESCRIPTOR

OpenGL on Windows

PIXELFORMATDESCRIPTOR

WGL Functions

wglCreateLayerContext