gl_framebuffer Struct Reference

#include <mtypes.h>

---

Detailed Description

A framebuffer is a collection of renderbuffers (color, depth, stencil, etc).

In C++ terms, think of this as a base class from which device drivers will make derived classes.

Data Fields
_glthread_Mutex	Mutex
	for thread safety
GLuint	Name
	If zero, this is a window system framebuffer.
GLint	RefCount
GLboolean	DeletePending
GLvisual	Visual
	The framebuffer's visual.
GLboolean	Initialized
GLuint	Width
GLuint	Height
	size of frame buffer in pixels
GLenum	_Status
	One of the GL_FRAMEBUFFER_(IN)COMPLETE_* tokens.
struct gl_renderbuffer_attachment	Attachment [BUFFER_COUNT]
	Array of all renderbuffer attachments, indexed by BUFFER_* tokens.
GLenum	ColorDrawBuffer [MAX_DRAW_BUFFERS]
GLenum	ColorReadBuffer
GLuint	_NumColorDrawBuffers
	Computed from ColorDraw/ReadBuffer above.
GLint	_ColorDrawBufferIndexes [MAX_DRAW_BUFFERS]
	BUFFER_x or -1.
GLint	_ColorReadBufferIndex
struct gl_renderbuffer *	_ColorDrawBuffers [MAX_DRAW_BUFFERS]
struct gl_renderbuffer *	_ColorReadBuffer
struct gl_renderbuffer *	_DepthBuffer
	The Actual depth/stencil buffers to use.
struct gl_renderbuffer *	_StencilBuffer
void(*	Delete )(struct gl_framebuffer *fb)
	Delete this framebuffer.
Drawing bounds (Intersection of buffer size and scissor box)
GLint	_Xmin
GLint	_Xmax
	inclusive
GLint	_Ymin
GLint	_Ymax
	exclusive
Derived Z buffer stuff
GLuint	_DepthMax
	Max depth buffer value.
GLfloat	_DepthMaxF
	Float max depth buffer value.
GLfloat	_MRD
	minimum resolvable difference in Z values

---

Field Documentation

_glthread_Mutex gl_framebuffer::Mutex

for thread safety

GLuint gl_framebuffer::Name

If zero, this is a window system framebuffer.

If non-zero, this is a FBO framebuffer; note that for some devices (i.e. those with a natural pixel coordinate system for FBOs that differs from the OpenGL/Mesa coordinate system), this means that the viewport, polygon face orientation, and polygon stipple will have to be inverted.

GLint gl_framebuffer::RefCount

GLboolean gl_framebuffer::DeletePending

GLvisual gl_framebuffer::Visual

The framebuffer's visual.

Immutable if this is a window system buffer. Computed from attachments if user-made FBO.

GLboolean gl_framebuffer::Initialized

GLuint gl_framebuffer::Width

GLuint gl_framebuffer::Height

size of frame buffer in pixels

GLint gl_framebuffer::_Xmin

GLint gl_framebuffer::_Xmax

inclusive

GLint gl_framebuffer::_Ymin

GLint gl_framebuffer::_Ymax

exclusive

GLuint gl_framebuffer::_DepthMax

Max depth buffer value.

GLfloat gl_framebuffer::_DepthMaxF

Float max depth buffer value.

GLfloat gl_framebuffer::_MRD

minimum resolvable difference in Z values

GLenum gl_framebuffer::_Status

One of the GL_FRAMEBUFFER_(IN)COMPLETE_* tokens.

struct gl_renderbuffer_attachment gl_framebuffer::Attachment[BUFFER_COUNT] [read]

Array of all renderbuffer attachments, indexed by BUFFER_* tokens.

GLenum gl_framebuffer::ColorDrawBuffer[MAX_DRAW_BUFFERS]

GLenum gl_framebuffer::ColorReadBuffer

GLuint gl_framebuffer::_NumColorDrawBuffers

Computed from ColorDraw/ReadBuffer above.

GLint gl_framebuffer::_ColorDrawBufferIndexes[MAX_DRAW_BUFFERS]

BUFFER_x or -1.

GLint gl_framebuffer::_ColorReadBufferIndex

struct gl_renderbuffer* gl_framebuffer::_ColorDrawBuffers[MAX_DRAW_BUFFERS] [read]

struct gl_renderbuffer* gl_framebuffer::_ColorReadBuffer [read]

struct gl_renderbuffer* gl_framebuffer::_DepthBuffer [read]

The Actual depth/stencil buffers to use.

May be wrappers around the depth/stencil buffers attached above.

struct gl_renderbuffer* gl_framebuffer::_StencilBuffer [read]

void(* gl_framebuffer::Delete)(struct gl_framebuffer *fb)

Delete this framebuffer.

---

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

• mtypes.h

---