Comment updates for texture and framebuffer classes.

[libs/gl.git] / source / framebuffer.h

diff --git a/source/framebuffer.h b/source/framebuffer.h
index e33deda9218d9bf3afea690b44fc1e9dd6329bc1..cf64b45c37ef28cb88394d6ecca86c3c0f1fd8e4 100644 (file)
--- a/source/framebuffer.h
+++ b/source/framebuffer.h
@@ -66,7 +66,8 @@ A framebuffer consist of a number of logical buffers, such as color and depth
 buffers.  Renderbuffers and Textures can be attached to the logical buffers.  At
 least one image must be attached for the framebuffer to be usable.
 
-Requires the GL_EXT_framebuffer_object extension.
+Requires the GL_EXT_framebuffer_object extension.  The blit functions require
+the GL_EXT_framebuffer_blit extension.
 */
 class Framebuffer: public Bindable<Framebuffer>
 {
@@ -112,17 +113,27 @@ public:
        void attach(FramebufferAttachment attch, TextureCube &tex, TextureCubeFace face, unsigned level = 0);
        void detach(FramebufferAttachment attch);
 
-       /**
-       Checks the completeness status of the framebuffer.  Returns
-       FRAMEBUFFER_COMPLETE if the framebuffer is complate and can be rendered to,
-       or one of the error status codes otherwise.
-       */
+       /** Checks the completeness of the framebuffer.  Returns
+       FRAMEBUFFER_COMPLETE if the framebuffer is complete and can be rendered to,
+       or one of the error status codes otherwise. */
        FramebufferStatus check_status() const;
 
        void clear(BufferBits);
-       void blit_from(const Framebuffer &, int, int, int, int, int, int, int, int, BufferBits, bool);
-       void blit_from(const Framebuffer &, int, int, unsigned, unsigned, int, int, BufferBits);
-       void blit_from(const Framebuffer &, BufferBits, bool);
+
+       /** Blits a region from another framebuffer into this one.  If the source
+       and destination regions have different dimensions, the contents will be
+       stretched.  If filter is true, linear interpolation will be used, otherwise
+       no interpolation is done. */
+       void blit_from(const Framebuffer &other, int sx0, int sy0, int sx1, int sy1,
+               int dx0, int dy0, int dx1, int dy1, BufferBits bits, bool filter);
+
+       /** Blits a region from another framebuffer into this one, retaining its
+       dimensions. */
+       void blit_from(const Framebuffer & other, int sx, int sy,
+               unsigned wd, unsigned ht, int dx, int dy, BufferBits bits);
+
+       /** Blits the entire contents of another framebuffer into this one. */
+       void blit_from(const Framebuffer &other, BufferBits bits, bool filter);
 
        void bind() const;