JUCE  v5.1.1-3-g1a0b28c73
JUCE API
Public Member Functions | Public Attributes | List of all members
OpenGLPixelFormat Class Reference

Represents the various properties of an OpenGL pixel format. More...

#include <juce_OpenGLPixelFormat.h>

Collaboration diagram for OpenGLPixelFormat:
Collaboration graph
[legend]

Public Member Functions

 OpenGLPixelFormat (int bitsPerRGBComponent=8, int alphaBits=8, int depthBufferBits=16, int stencilBufferBits=0) noexcept
 Creates an OpenGLPixelFormat. More...
 
bool operator!= (const OpenGLPixelFormat &) const noexcept
 
bool operator== (const OpenGLPixelFormat &) const noexcept
 

Public Attributes

int accumulationBufferAlphaBits
 The number of bits per pixel to use for an accumulation buffer's alpha channel. More...
 
int accumulationBufferBlueBits
 The number of bits per pixel to use for an accumulation buffer's blue channel. More...
 
int accumulationBufferGreenBits
 The number of bits per pixel to use for an accumulation buffer's green channel. More...
 
int accumulationBufferRedBits
 The number of bits per pixel to use for an accumulation buffer's red channel. More...
 
int alphaBits
 The number of bits per pixel to use for the alpha channel. More...
 
int blueBits
 The number of bits per pixel to use for the blue channel. More...
 
int depthBufferBits
 The number of bits per pixel to use for a depth buffer. More...
 
int greenBits
 The number of bits per pixel to use for the green channel. More...
 
uint8 multisamplingLevel
 The number of samples to use for full-scene multisampled anti-aliasing (if available). More...
 
int redBits
 The number of bits per pixel to use for the red channel. More...
 
int stencilBufferBits
 The number of bits per pixel to use for a stencil buffer. More...
 

Detailed Description

Represents the various properties of an OpenGL pixel format.

See also
OpenGLContext::setPixelFormat

Constructor & Destructor Documentation

◆ OpenGLPixelFormat()

OpenGLPixelFormat::OpenGLPixelFormat ( int  bitsPerRGBComponent = 8,
int  alphaBits = 8,
int  depthBufferBits = 16,
int  stencilBufferBits = 0 
)
noexcept

Creates an OpenGLPixelFormat.

The default constructor just initialises the object as a simple 8-bit RGBA format.

Member Function Documentation

◆ operator!=()

bool OpenGLPixelFormat::operator!= ( const OpenGLPixelFormat &  ) const
noexcept

◆ operator==()

bool OpenGLPixelFormat::operator== ( const OpenGLPixelFormat &  ) const
noexcept

Member Data Documentation

◆ accumulationBufferAlphaBits

int OpenGLPixelFormat::accumulationBufferAlphaBits

The number of bits per pixel to use for an accumulation buffer's alpha channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ accumulationBufferBlueBits

int OpenGLPixelFormat::accumulationBufferBlueBits

The number of bits per pixel to use for an accumulation buffer's blue channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ accumulationBufferGreenBits

int OpenGLPixelFormat::accumulationBufferGreenBits

The number of bits per pixel to use for an accumulation buffer's green channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ accumulationBufferRedBits

int OpenGLPixelFormat::accumulationBufferRedBits

The number of bits per pixel to use for an accumulation buffer's red channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ alphaBits

int OpenGLPixelFormat::alphaBits

The number of bits per pixel to use for the alpha channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ blueBits

int OpenGLPixelFormat::blueBits

The number of bits per pixel to use for the blue channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ depthBufferBits

int OpenGLPixelFormat::depthBufferBits

The number of bits per pixel to use for a depth buffer.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), JuceGLView::layerClass, OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ greenBits

int OpenGLPixelFormat::greenBits

The number of bits per pixel to use for the green channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ multisamplingLevel

uint8 OpenGLPixelFormat::multisamplingLevel

The number of samples to use for full-scene multisampled anti-aliasing (if available).

Referenced by OpenGLContext::NativeContext::createAttribs(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ redBits

int OpenGLPixelFormat::redBits

The number of bits per pixel to use for the red channel.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

◆ stencilBufferBits

int OpenGLPixelFormat::stencilBufferBits

The number of bits per pixel to use for a stencil buffer.

Referenced by OpenGLContext::NativeContext::createAttribs(), OpenGLContext::NativeContext::initialisePixelFormatDescriptor(), OpenGLContext::NativeContext::NativeContext(), and OpenGLContext::NativeContext::wglChoosePixelFormatExtension().

The documentation for this class was generated from the following file: