MonobjcMonobjc Documented Class Library
CGLPixelFormatAttribute Enumeration
NamespacesMonobjc.OpenGLCGLPixelFormatAttribute

Specify attributes used to choose pixel formats and virtual screens.

Available in Mac OS X v10.0 and later.

Declaration Syntax
C#Visual BasicVisual C++
public enum CGLPixelFormatAttribute
Public Enumeration CGLPixelFormatAttribute
public enum class CGLPixelFormatAttribute
Members
MemberDescription
kCGLPFAAllRenderers

This constant is a Boolean attribute. If it is present in the attributes array, pixel format selection is open to all available renderers, including debug and special-purpose renderers that are not OpenGL compliant. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFADoubleBuffer

This constant is a Boolean attribute. If it is present in the attributes array, only double-buffered pixel formats are considered. Otherwise, only single-buffered pixel formats are considered. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAStereo

This constant is a Boolean attribute. If it is present in the attributes array, only stereo pixel formats are considered. Otherwise, only monoscopic pixel formats are considered. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAAuxBuffers

The associated value is a nonnegative integer that indicates the desired number of auxiliary buffers. Pixel formats with the smallest number of auxiliary buffers that meet or exceed the specified number are preferred.

Available in Mac OS X v10.0 and later.


kCGLPFAColorSize

The associated value is a nonnegative buffer size specification. A color buffer that most closely matches the specified size is preferred. If unspecified, OpenGL chooses a color buffer size that matches the screen.

Available in Mac OS X v10.0 and later.


kCGLPFAAlphaSize

The associated value is a nonnegative buffer size specification. An alpha buffer that most closely matches the specified size is preferred.

Available in Mac OS X v10.0 and later.


kCGLPFADepthSize

The associated value is a nonnegative depth buffer size specification. A depth buffer that most closely matches the specified size is preferred.

Available in Mac OS X v10.0 and later.


kCGLPFAStencilSize

The associated value is a nonnegative integer that indicates the desired number of stencil bitplanes. The smallest stencil buffer of at least the specified size is preferred.

Available in Mac OS X v10.0 and later.


kCGLPFAAccumSize

The associated value is a nonnegative buffer size specification. An accumulation buffer that most closely matches the specified size is preferred.

Available in Mac OS X v10.0 and later.


kCGLPFAMinimumPolicy

This constant is a Boolean attribute. If it is present in the attributes array, the pixel format choosing policy is altered for the color, depth, and accumulation buffers such that only buffers of size greater than or equal to the desired size are considered. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAMaximumPolicy

This constant is a Boolean attribute. If it is present in the attributes array, the pixel format choosing policy is altered for the color, depth, and accumulation buffers such that, if a nonzero buffer size is requested, the largest available buffer is preferred. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAOffScreen

This constant is a Boolean attribute. If it is present in the attributes array, only renderers that are capable of rendering to an offscreen memory area and have buffer depth exactly equal to the desired buffer depth are considered. The kCGLPFAClosestPolicy attribute is implied. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAFullScreen

This constant is a Boolean attribute. If it is present in the attributes array, only renderers that are capable of rendering to a full-screen drawable object are considered. The kCGLPFASingleRenderer attribute is implied. Do not supply a value with this constant because its presence in the array implies true. (Deprecated. Deprecated in Mac OS X v10.6 or later.)

Available in Mac OS X v10.0 and later.


kCGLPFASampleBuffers

The number of multisample buffers. The associated value is a nonnegative integer that indicates the number of existing independent sample buffers. Typically, the value is 0 if no multisample buffer exists or 1. This attribute is not useful in the attribute array.

Available in Mac OS X v10.1 and later.


kCGLPFASamples

The number of samples per multisample buffer. The associated value is a nonnegative integer that indicates the desired number of samples that can be taken within a single pixel. The smallest sample buffer with at least the specified number of samples is preferred.

Available in Mac OS X v10.1 and later.


kCGLPFAAuxDepthStencil

This constant is a Boolean attribute. If it is present in the attributes array, each auxiliary buffer has its own depth-stencil buffer. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.2 and later.


kCGLPFAColorFloat

This constant is a Boolean attribute. If it is present in the attributes array, color buffers store floating-point pixels. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.2 and later.


kCGLPFAMultisample

This constant is a Boolean attribute. If it is present in the attributes array, specifies a hint to the driver to prefer multisampling. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.3 and later.


kCGLPFASupersample

This constant is a Boolean attribute. If it is present in the attributes array, specifies a hint to the driver to prefer supersampling. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.3 and later.


kCGLPFASampleAlpha

This constant is a Boolean attribute. If it is present in the attributes array, request alpha filtering when multisampling. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.3 and later.


kCGLPFARendererID

The associated value is a nonnegative renderer ID number and can be any of the constants defined in “Renderer IDs.” OpenGL renderers that match the specified ID are preferred. Of note is kCGLRendererGenericID, which selects the Apple software renderer. The other constants select renderers for specific hardware vendors.

Available in Mac OS X v10.0 and later.


kCGLPFASingleRenderer

This constant is a Boolean attribute. If it is present in the attributes array, a single rendering engine is chosen. On systems with multiple displays, this disables ability of OpenGL to drive different displays through different graphics accelerator cards with a single context. This attribute is not generally useful. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFANoRecovery

This constant is a Boolean attribute. If it is present in the attributes array, the OpenGL failure recovery mechanisms are disabled. Normally, if an accelerated renderer fails due to lack of resources, OpenGL automatically switches to another renderer. This attribute disables these features so that rendering is always performed by the chosen renderer. This attribute is not generally useful. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAAccelerated

This constant is a Boolean attribute. If it is present in the attributes array, only hardware accelerated renderers are considered. If false, accelerated renderers are still preferred. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAClosestPolicy

This constant is a Boolean attribute. If it is present in the attributes array, the pixel format choosing policy is altered for the color buffer such that the buffer closest to the requested size is preferred, regardless of the actual color buffer depth of the supported graphics device. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFARobust

This constant is a Boolean attribute. If it is present in the attributes array, only renderers that do not have any failure modes associated with a lack of video card resources are considered. This attribute is not generally useful. Do not supply a value with this constant because its presence in the array implies true. (Deprecated. Deprecated in Mac OS X 10.5 and later.)

Available in Mac OS X v10.0 and later.


kCGLPFABackingStore

This constant is a Boolean attribute. If it is present in the attributes array, OpenGL considers only renderers that have a back color buffer the full size of the drawable object and that guarantee the back buffer contents to be valid after a call to CGLFlushDrawable. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAMPSafe

This constant is a Boolean attribute. If it is present in the attributes array, OpenGL considers only renderers that are thread-safe. Because all renderers are thread-safe, this attribute is not useful. Do not supply a value with this constant because its presence in the array implies true. (Deprecated. Deprecated in Mac OS X 10.5 and later.)

Available in Mac OS X v10.0 and later.


kCGLPFAWindow

This constant is a Boolean attribute. If it is present in the attributes array, only renderers that are capable of rendering to a window are considered. This attribute is implied if neither kCGLPFAFullScreen nor kCGLPFAOffScreen is specified. Because CGL supports only full-screen or offscreen drawable objects, this attribute is not useful. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFAMultiScreen

This constant is a Boolean attribute. If it is present in the attributes array, only renderers capable of driving multiple displays are considered. This attribute is not generally useful. Do not supply a value with this constant because its presence in the array implies true. (Deprecated. Deprecated in Mac OS X 10.5 and later.)

Available in Mac OS X v10.0 and later.


kCGLPFACompliant

This constant is a Boolean attribute. If it is present in the attributes array, pixel format selection is only open to OpenGL compliant renderers. This attribute is implied unless kCGLPFAAllRenderers is specified. This attribute is not useful in the attribute array. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.0 and later.


kCGLPFADisplayMask

The associated value is a bit mask of supported physical displays. All displays specified in the bit mask are guaranteed to be supported by the pixel format. Displays not specified in the bit mask may still be supported. The bit mask is managed by the Quartz Display Services, available in the CGDirectDisplay.h header of the Application Services umbrella framework. A CGDirectDisplayID must be converted to an OpenGL display mask using the function CGDisplayIDToOpenGLDisplayMask. This attribute is not generally useful.

Available in Mac OS X v10.0 and later.


kCGLPFAPBuffer

This constant is a Boolean attribute. If it is present in the attributes array, the pixel format can be used to render to a pixel buffer. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.3 and later.


kCGLPFARemotePBuffer

This constant is a Boolean attribute. If it is present in the attributes array, the pixel format can be used to render offline to a pixel buffer. Do not supply a value with this constant because its presence in the array implies true.

Available in Mac OS X v10.3 and later.


kCGLPFAAllowOfflineRenderers

This constant is a Boolean attribute. If it is present in the attribute array, renderers that are available but not currently connected to a display may be considered.

Available in Mac OS X v10.5 and later.


kCGLPFAAcceleratedCompute

This constant is a Boolean attribute. If it is present in the attributes array, only renderers that render to a hardware device that is capable of OpenCL processing are considered.

Available in Mac OS X v10.6 and later.


kCGLPFAVirtualScreenCount

This attribute may be used to obtain the number of virtual screens specified by an existing pixel format object. To retrieve the value, call the function CGLDescribePixelFormat, passing the pixel format object, the virtual screen number 0, and this attribute. This attribute is not useful in the attribute array that's used to create a pixel format object.

Available in Mac OS X v10.0 and later.


Version Information
  • Available in Monobjc Bridge: 10.6 (For Mac OS X 10.6 and later), 10.5 (For Mac OS X 10.5 and later)

Assembly: Monobjc.OpenGL (Module: Monobjc.OpenGL)