Wizt::Renderbuffer Class Reference

Encapsulation of the OpenGL Renderbuffer API. More...

#include </home/werner/origo/vish/ocean/GLvish/Framebuffer.hpp>

List of all members.

Classes

• struct Properties

  Properties of a Renderbuffer object. More...
  

Public Types

• enum ErrorCode { OK = 0, TOO_LARGE = -1, OUT_OF_MEMORY = -2 }

Public Member Functions

• ErrorCode alloc (GLenum internalformat, GLsizei width, GLsizei height, GLsizei samples=0)
• ErrorCode alloc (GLenum internalformat, const Properties &P)
• void bind () const

  Bind this Renderbuffer.
  

• void draw (GLsizei width, GLsizei height, GLenum format, GLenum type, const GLvoid *pixels)
• const Properties & getProperties () const

  Get the properties of this Renderbuffer.
  

• bool isAllocated () const
• bool read (GLint x, GLint y, GLsizei width, GLsizei height, GLenum format, GLenum type, GLvoid *pixels) const

  http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/readpixels.html
  

• template<class Type > bool read (Type *Data, GLenum format, GLsizei width, GLsizei height, GLint x=0, GLint y=0)

  http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/readpixels.html
  

• template<class Type > bool read (std::vector< Type > &Data, GLenum format, GLsizei width, GLsizei height, GLint x=0, GLint y=0)
• MemCore::RefPtr
  < MemCore::ChunkBase > read (GLsizei width, GLsizei height, GLenum format, const std::type_info &MemType, GLint x=0, GLint y=0)
• template<class T > MemCore::RefPtr
  < MemCore::Chunk< T > > read (GLsizei width, GLsizei height, GLenum format, GLint x=0, GLint y=0)
• Renderbuffer ()

  Constructor.
  

• ~Renderbuffer ()

  Destructor.
  

Static Public Member Functions

• static MemCore::RefPtr
  < Renderbuffer > Alloc (GLenum internalformat, GLsizei width, GLsizei height, GLsizei samples=0)
• static ErrorCode glAlloc (GLenum internalformat, GLsizei width, GLsizei height, GLsizei samples=0)
• static GLint maxSize ()
• static MemCore::RefPtr
  < Renderbuffer > New (GLenum internalformat, GLsizei width, GLsizei height, GLsizei samples=0)
• static void unbind ()

  Unbind all Renderbuffers.
  

Public Attributes

• Properties properties

Friends

• class Framebuffer

---

Detailed Description

Encapsulation of the OpenGL Renderbuffer API.

---

Member Function Documentation

Renderbuffer::ErrorCode Wizt::Renderbuffer::glAlloc	(	GLenum	internalformat,
		GLsizei	width,
		GLsizei	height,
		GLsizei	samples = 0
	)		[static]

Parameters:

samples

What happens when <samples> is zero or one? 0= single sample, 1 = minimum multisample

Zero means single sample, as if RenderbufferStorageEXT had been called instead of RenderbufferStorageMultisampleEXT. One means minimum number of samples supported by implementation.

There was a question if one should mean the same thing as single-sample (one sample), or if it should mean the minimum supported number of samples for multisample rendering. The rules for rasterizing in "multisample" mode are different than "non-multisample" mode. In the end, we decided that some implementations may wish to support a "one-sample" multisample buffer to allow for multipass multisampling where the sample location can be varied either by the implementation or perhaps explicitly by a "multisample location" extension. http://www.opengl.org/registry/specs/EXT/framebuffer_multisample.txt

bool Wizt::Renderbuffer::read	(	GLint	x,
		GLint	y,
		GLsizei	width,
		GLsizei	height,
		GLenum	format,
		GLenum	type,
		GLvoid *	pixels
	)		const

http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/readpixels.html

Note:

http://www.opengl.org/registry/specs/EXT/framebuffer_multisample.txt ReadPixels generates INVALID_OPERATION if READ_FRAMEBUFFER_BINDING (section 4.4) is non-zero, the read framebuffer is framebuffer complete, and the value of SAMPLE_BUFFERS for the read framebuffer is greater than zero.

Is ReadPixels (or CopyPixels or CopyTexImage) permitted when bound to a multisample framebuffer object? RESOLVED, no

template<class Type >

bool Wizt::Renderbuffer::read	(	Type *	Data,
		GLenum	format,
		GLsizei	width,
		GLsizei	height,
		GLint	x = 0,
		GLint	y = 0
	)		[inline]

http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/readpixels.html

Parameters:

format

Specifies the format of the pixel data. The following symbolic values are accepted: GL_COLOR_INDEX, GL_STENCIL_INDEX, GL_DEPTH_COMPONENT, GL_RED, GL_GREEN, GL_BLUE, GL_ALPHA, GL_RGB, GL_RGBA, GL_LUMINANCE, and GL_LUMINANCE_ALPHA.

---

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

• ocean/GLvish/Framebuffer.hpp
• ocean/GLvish/Framebuffer.cpp