|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.opengl.QGLFramebufferObject
public class QGLFramebufferObject
The QGLFramebufferObject
class encapsulates an OpenGL
framebuffer object. The QGLFramebufferObject
class encapsulates an OpenGL
framebuffer object, defined by the GL_EXT_framebuffer_object extension. In addition it provides a rendering surface that can be painted on with a QPainter
, rendered to using native GL calls, or both. This surface can be bound and used as a regular texture in your own GL drawing code. By default, the QGLFramebufferObject
class generates a 2D GL texture (using the GL_TEXTURE_2D target), which is used as the internal rendering target.
It is important to have a current GL context when creating a QGLFramebufferObject
, otherwise initialization will fail.
OpenGL
framebuffer objects and pbuffers (see QGLPixelBuffer
) can both be used to render to offscreen surfaces, but there are a number of advantages with using framebuffer objects instead of pbuffers:
OpenGL
framebuffer extension is a pure GL extension with no system dependant WGL, AGL or GLX parts. This makes using framebuffer objects more portable.QPainter
antialiasing of drawing primitives will not work when using a QGLFramebufferObject
as a paintdevice. This is because sample buffers, which are needed for antialiasing, are not yet supported in application-defined framebuffer objects. However, an extension to solve this has already been approved by the OpenGL
ARB (GL_EXT_framebuffer_multisample), and will most likely be available in the near future.
Nested Class Summary | |
---|---|
static class |
QGLFramebufferObject.Attachment
This enum type is used to configure the depth and stencil buffers attached to the framebuffer object when it is created. |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9 |
Constructor Summary | |
---|---|
QGLFramebufferObject(int width,
int height)
Constructs an OpenGL framebuffer object and binds a 2D GL texture to the buffer of the given width and height. |
|
QGLFramebufferObject(int width,
int height,
int target)
Constructs an OpenGL framebuffer object and binds a 2D GL texture to the buffer of the given width and height. |
|
QGLFramebufferObject(int width,
int height,
QGLFramebufferObject.Attachment attachment)
Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given width and height. |
|
QGLFramebufferObject(int width,
int height,
QGLFramebufferObject.Attachment attachment,
int target)
Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given width and height. |
|
QGLFramebufferObject(int width,
int height,
QGLFramebufferObject.Attachment attachment,
int target,
int internal_format)
Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given width and height. |
|
QGLFramebufferObject(QSize size)
Constructs an OpenGL framebuffer object and binds a 2D GL texture to the buffer of the size size. |
|
QGLFramebufferObject(QSize size,
int target)
Constructs an OpenGL framebuffer object and binds a 2D GL texture to the buffer of the size size. |
|
QGLFramebufferObject(QSize size,
QGLFramebufferObject.Attachment attachment)
Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given size. |
|
QGLFramebufferObject(QSize size,
QGLFramebufferObject.Attachment attachment,
int target)
Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given size. |
|
QGLFramebufferObject(QSize size,
QGLFramebufferObject.Attachment attachment,
int target,
int internal_format)
Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given size. |
Method Summary | |
---|---|
QGLFramebufferObject.Attachment |
attachment()
Returns the status of the depth and stencil buffers attached to this framebuffer object. |
boolean |
bind()
Switches rendering from the default, windowing system provided framebuffer to this framebuffer object. |
int |
depth()
Returns the bit depth (number of bit planes) of the paint device. |
void |
drawTexture(QPointF point,
int textureId)
Draws the given texture, textureId, at the given point in OpenGL model space. |
void |
drawTexture(QPointF point,
int textureId,
int textureTarget)
Draws the given texture, textureId, at the given point in OpenGL model space. |
void |
drawTexture(QRectF target,
int textureId)
Draws the given texture, textureId, to the given target rectangle, target, in OpenGL model space. |
void |
drawTexture(QRectF target,
int textureId,
int textureTarget)
Draws the given texture, textureId, to the given target rectangle, target, in OpenGL model space. |
static QGLFramebufferObject |
fromNativePointer(QNativePointer nativePointer)
|
int |
handle()
Returns the GL framebuffer object handle for this framebuffer object (returned by the glGenFrameBuffersEXT() function). |
static boolean |
hasOpenGLFramebufferObjects()
Returns true if the OpenGL GL_EXT_framebuffer_object extension is present on this system; otherwise returns false. |
int |
height()
Returns the height of the paint device in default coordinate system units (e.g. |
int |
heightMM()
Returns the height of the paint device in millimeters. |
boolean |
isValid()
Returns true if the framebuffer object is valid. |
int |
logicalDpiX()
Returns the horizontal resolution of the device in dots per inch, which is used when computing font sizes. |
int |
logicalDpiY()
Returns the vertical resolution of the device in dots per inch, which is used when computing font sizes. |
int |
metric(QPaintDevice.PaintDeviceMetric metric)
Returns the metric information for the given paint device metric. |
int |
numColors()
Returns the number of different colors available for the paint device. |
QPaintEngine |
paintEngine()
Returns a pointer to the paint engine used for drawing on the device. |
boolean |
paintingActive()
Returns true if the device is currently being painted on, i.e. |
int |
physicalDpiX()
Returns the horizontal resolution of the device in dots per inch. |
int |
physicalDpiY()
Returns the horizontal resolution of the device in dots per inch. |
boolean |
release()
Switches rendering back to the default, windowing system provided framebuffer. |
QSize |
size()
Returns the size of the texture attached to this framebuffer object. |
int |
texture()
Returns the texture id for the texture attached as the default rendering target in this framebuffer object. |
QImage |
toImage()
Returns the contents of this framebuffer object as a QImage . |
int |
width()
Returns the width of the paint device in default coordinate system units (e.g. |
int |
widthMM()
Returns the width of the paint device in millimeters. |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class java.lang.Object |
---|
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Constructor Detail |
---|
public QGLFramebufferObject(QSize size)
The target parameter is used to specify the GL texture target. The default target is GL_TEXTURE_2D. Keep in mind that GL_TEXTURE_2D textures must have a power of 2 width and height (e.g. 256x512), unless you are using OpenGL 2.0 or higher.
By default, no depth and stencil buffers are attached. This behavior can be toggled using one of the overloaded constructors.
The default internal texture format is GL_RGBA8.
It is important that you have a current GL context set when creating the QGLFramebufferObject
, otherwise the initialization will fail.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(QSize size, int target)
The target parameter is used to specify the GL texture target. The default target is GL_TEXTURE_2D. Keep in mind that GL_TEXTURE_2D textures must have a power of 2 width and height (e.g. 256x512), unless you are using OpenGL 2.0 or higher.
By default, no depth and stencil buffers are attached. This behavior can be toggled using one of the overloaded constructors.
The default internal texture format is GL_RGBA8.
It is important that you have a current GL context set when creating the QGLFramebufferObject
, otherwise the initialization will fail.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(QSize size, QGLFramebufferObject.Attachment attachment, int target)
The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internal_format the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(QSize size, QGLFramebufferObject.Attachment attachment)
The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internal_format the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(QSize size, QGLFramebufferObject.Attachment attachment, int target, int internal_format)
The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internal_format the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(int width, int height)
size()
, and texture()
.
public QGLFramebufferObject(int width, int height, int target)
size()
, and texture()
.
public QGLFramebufferObject(int width, int height, QGLFramebufferObject.Attachment attachment, int target)
The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internal_format the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(int width, int height, QGLFramebufferObject.Attachment attachment)
The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internal_format the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8.
size()
, texture()
, and attachment()
.
public QGLFramebufferObject(int width, int height, QGLFramebufferObject.Attachment attachment, int target, int internal_format)
The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internal_format the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8.
size()
, texture()
, and attachment()
.
Method Detail |
---|
public final QGLFramebufferObject.Attachment attachment()
public final boolean bind()
public final int depth()
depth
in interface QPaintDeviceInterface
public final void drawTexture(QPointF point, int textureId)
The framebuffer object should be bound when calling this function.
Equivalent to the corresponding QGLContext::drawTexture()
.
public final void drawTexture(QPointF point, int textureId, int textureTarget)
The framebuffer object should be bound when calling this function.
Equivalent to the corresponding QGLContext::drawTexture()
.
public final void drawTexture(QRectF target, int textureId)
OpenGL
model space. The textureTarget should be a 2D texture target. The framebuffer object should be bound when calling this function.
Equivalent to the corresponding QGLContext::drawTexture()
.
public final void drawTexture(QRectF target, int textureId, int textureTarget)
OpenGL
model space. The textureTarget should be a 2D texture target. The framebuffer object should be bound when calling this function.
Equivalent to the corresponding QGLContext::drawTexture()
.
public final int handle()
public final int height()
QPixmap
and QWidget
). heightMM()
.
height
in interface QPaintDeviceInterface
public final int heightMM()
height()
.
heightMM
in interface QPaintDeviceInterface
public final boolean isValid()
The framebuffer can become invalid if the initialization process fails, the user attaches an invalid buffer to the framebuffer object, or a non-power of 2 width/height is specified as the texture size if the texture target is GL_TEXTURE_2D.
public final int logicalDpiX()
widthMM()
. Note that if the logicalDpiX()
doesn't equal the physicalDpiX()
, the corresponding QPaintEngine
must handle the resolution mapping.
logicalDpiY()
, and physicalDpiX()
.
logicalDpiX
in interface QPaintDeviceInterface
public final int logicalDpiY()
heightMM()
. Note that if the logicalDpiY()
doesn't equal the physicalDpiY()
, the corresponding QPaintEngine
must handle the resolution mapping.
logicalDpiX()
, and physicalDpiY()
.
logicalDpiY
in interface QPaintDeviceInterface
public final int numColors()
INT_MAX
is returned instead.
numColors
in interface QPaintDeviceInterface
public final boolean paintingActive()
QPainter::begin()
but not yet called QPainter::end()
for this device; otherwise returns false. QPainter::isActive()
.
paintingActive
in interface QPaintDeviceInterface
public final int physicalDpiX()
Note that if the physicalDpiX()
doesn't equal the logicalDpiX()
, the corresponding QPaintEngine
must handle the resolution mapping.
physicalDpiY()
, and logicalDpiX()
.
physicalDpiX
in interface QPaintDeviceInterface
public final int physicalDpiY()
Note that if the physicalDpiY()
doesn't equal the logicalDpiY()
, the corresponding QPaintEngine
must handle the resolution mapping.
physicalDpiX()
, and logicalDpiY()
.
physicalDpiY
in interface QPaintDeviceInterface
public final boolean release()
public final QSize size()
public final int texture()
public final QImage toImage()
QImage
.
public final int width()
QPixmap
and QWidget
). widthMM()
.
width
in interface QPaintDeviceInterface
public final int widthMM()
width()
.
widthMM
in interface QPaintDeviceInterface
public int metric(QPaintDevice.PaintDeviceMetric metric)
PaintDeviceMetric
.
metric
in interface QPaintDeviceInterface
public QPaintEngine paintEngine()
paintEngine
in interface QPaintDeviceInterface
public static boolean hasOpenGLFramebufferObjects()
OpenGL
GL_EXT_framebuffer_object extension is present on this system; otherwise returns false.
public static QGLFramebufferObject fromNativePointer(QNativePointer nativePointer)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |