Home Page Toolkit Overview Using GML   User Input Services     Finger Tracker     Calibrator     Frame Grabber     Service protocol Obtaining GML   Installing GML   Licence Developer Documentation   Tcl/Tk API     The GML Canvas     Image processing   Tcl Scripts Library     List of Classes     List of Files   C/C++ API     List of Classes     List of Files

gml_GL_Texture.h // gml_GL_Texture.h -- // // Manage creation and update of OpenGL textures from GML bitmaps. // // Copyright (c) 2004 CLIPS-IMAG // // See the file "gml_LicenseTerms.txt" for information on usage and redistribution // of this file, and for a DISCLAIMER OF ALL WARRANTIES. // // TODO: // * asynchronous download // * check for extensions: EXT_texture_rectangle, EXT_framebuffer_object, // ARB_pixel_buffer_object // // January 2005 (JL) // Removed the Copy method (copying is now performed lazily by Enable()). // Made textures robust to change in GL context (the texture will // be re-uploaded if the context changes). // // August 13, 2004 (FB) // Renamed files from "gml_TextureGL.*" to "gml_GL_Texture.*". // "Coords" and "NormalCoords" now return "void" (was "gml_TError"). // Renamed "Preflight" method into "SetBitmap". // Added "UpdateFromBitmap" method. // "Copy" only update the texture if necessary (addition of a "fDirty" flag). // // Created on August, 3 2004 (JL). #ifndef __GML_GL_TEXTURE__ #define __GML_GL_TEXTURE__ #include "gml/base/gml_Errors.h" #include "gml/image/gml_Bitmap.h" #include "gml/image/gml_Geometry.h" #include "gml/gl/gml_GL_Base.h" /// /// gmlGL_TTexture -- /// /// Abstraction of OpenGL textures, that allows texture uploading from GML bitmaps. /// /// @todo isolate the GL implementation of the texture from an abstract texture type. /// The abstract type should only have "Init", "Dispose", "SetBitmap", "Update", /// and "Exists" methods. The other ones are GL specific. /// class gmlGL_TTexture { public: /// /// Init -- /// Zero the structure. No side effects. /// gml_TError Init (); /// /// Dispose -- /// Release the GL resources used by this texture, if any. /// /// Can be called at any time. /// void Dispose (); /// /// Upload -- /// Copy the specified region <roi> of the <bitmap> to the texture. /// The OpenGL texture may need to be re-created. /// /// If <roi> is NULL, use the whole bitmap. /// /// If <persistent> is false, this means that <bitmap> is not persistent and /// a private copy is made by the texture object. /// If true, the bitmap is considered persistent until the deletion of the /// texture object. Its early destruction will result un undefined behavior. /// /// Return an error code if the <bitmap> has unsupported characteristics. /// /// Can be called at any time. /// gml_TError Upload (gml_TBitmap* bitmap, gml_TRect* roi = (gml_TRect*)NULL, gml_TBoolean persistent = gml_cFalse, gml_TBoolean alphaTexture = gml_cFalse); /// /// Download -- /// Copy the specified <source> region of the texture to the <dest> /// region of the <bitmap>. /// Fails for non-RGB texture encodings. Fast only if both the /// texture and the destination bitmap are 32-bit RGB. /// gml_TError Download (gml_TBitmap* bitmap, gml_TRect* source = (gml_TRect*)NULL, gml_TRect* dest = (gml_TRect*)NULL); /// /// BeginRenderTo -- /// Setup the sharing context so that GL operations draw to the texture. /// As a side effect, the current context is set to the sharing context. /// gml_TError BeginRenderTo (); /// /// EndRenderTo -- /// Commit render-to-texture operations. /// gml_TError EndRenderTo (); /// /// UpdateFromBitmap -- /// Notify the texture that the bitmap's pixels have been modified and so //// the texture should update itseld from the bitmap. /// /// Upload() must have been called since Init(). /// /// DEPRECATED. /// void UpdateFromBitmap (); /// /// Copy -- /// Copy region <source> of the texture to region <dest> of texture /// <other>. Any of the two regions may be passed as NULL, in which case /// the whole texture will be used. /// The regions will be clamped to the bounding rectangles. /// The regions need not be of the same size; the texture will be /// scaled appropriately. /// gml_TError Copy (gmlGL_TTexture* other, gml_TRect* source = NULL, gml_TRect* dest = NULL, Float32* transfo = NULL); /// /// Exists -- /// Return true if Upload() has successfully been called at least once. /// gml_TBoolean Exists (); /// /// OpenGL specific methods /// /// /// Enable -- /// Prepare to render the texture to OpenGL primitives. /// /// Equivalent to a call to <glEnable> and <glBindTexture> with /// the appropriate target. /// /// Note: if the current context is different from the last call to /// Enable(), the texture will be uploaded again. /// void Enable (); /// /// Disable -- /// Stop rendering the texture to OpenGL primitives. /// Equivalent to a call to <glDisable> with the appropriate target. /// /// The OpenGL context current when Enable() was called must be current. /// void Disable (); /// /// Coords -- /// Given pixel coordinates <ix> and <iy> in the bitmap, /// return in <ox> and <oy> the coordinates to be used in <glTexCoord>. /// /// Note: this is to take ordering and possible padding of the texture /// lines into account, as well as different coordinate conventions /// depending on the texture target used (GL_TEXTURE_2D or /// GL_TEXTURE_RECTANGLE_EXT). /// /// Can only be called after Upload(). /// void Coords (GLfloat ix, GLfloat iy, GLfloat &ox, GLfloat &oy); /// /// NormalCoords -- /// Same as Coords, but with input coordinates normalized to the size /// of the bitmap's region of interest. /// /// Can only be called after Upload(). /// void NormalCoords (GLfloat ix, GLfloat iy, GLfloat &ox, GLfloat &oy); /// /// Alpha -- /// Returns the transparency parameter of the bitmap pixel at coordinates /// <x>, <y>. /// /// If <x>, <y> is out of range of the texture, return 0 (fully transparent). /// If the texture has no transparency information, return 1 (fully opaque). /// /// Note: The origin of bitmap coordinates is at the top left corner /// of the texture . /// /// Can only be called after Upload(). /// Float32 Alpha (Float32 x, Float32 y); GLuint GLName () { return fName; } void Rect (gml_TRect &rect) { rect.fLeft = 0; rect.fTop = 0; rect.fRight = fRegionWidth; rect.fBottom = fRegionHeight; } private: gml_TBitmap* fBitmap; ///< the last <bitmap> argument passed to SetBitmap() gml_TBitmap* fPrivateCopy; ///< a private copy of the last bitmap passed to SetBitmap() gml_TBitmap* fShadow; ///< equal either to <fBitmap> or <fPrivateCopy> gml_TRect fRegion; ///< the last <roi> argument passed to SetBitmap() SInt32 fRegionWidth; SInt32 fRegionHeight; SInt32 fAlphaIndex; ///< byte index of the alpha channel in the bitmap's pixels, ///< or (-1) if it has no alpha. GLuint fWidth; ///< width of the OpenGL texture GLuint fHeight; ///< height of the OpenGL texture GLuint fName; ///< OpenGL handle for this texture gml_TBoolean fUploaded; ///< true if the texture has already been uploaded ///< at least once GLint fInternal; ///< Component layout of the texture in VRAM GLenum fFormat; ///< Component layout of the pixel data GLenum fType; ///< Data type of the pixel data GLenum fTarget; ///< Target texture type, GL_TEXTURE_2D or ///< GL_TEXTURE_RECTANGLE_EXT GLuint fFramebuffer; ///< virtual frame buffer user for render-to-texture operations GLuint fDownloadBuffer; GLuint fDownloadSize; gml_TBitmap fDownloadBitmap; /// /// CheckEncodingAndSize -- /// If the texture has already been uploaded with an incompatible bitmap /// (different dimensions or encodings), prepare to re-upload it. /// void CheckEncodingAndSize (gml_TBitmap *bm, gml_TRect *roi); void GLSetupUploadStart (); void GLSetupUploadEnd (); void GLUploadTexture (); void GLCreateTexture (); gml_TError DownloadReadPixels (gml_TBitmap* bitmap, gml_TRect* source, gml_TRect* dest); gml_TError DownloadGetTexImage (gml_TBitmap* bitmap, gml_TRect* source, gml_TRect* dest); }; #endif /* __GML_GL_TEXTURE__ */ Generated on Tue Jun 12 14:03:27 2007 for gml by Doxygen 1.5.2.

Contact: julien (dot) letessier (at) gmail (dot) com. Copyright (c) 2000-2007 CLIPS-IMAG Laboratory, Grenoble, France. All rights reserved. W3CXHTML 1.0 W3CCSS 2.0