root/OpenSceneGraph/trunk/include/osg/Image @ 10866

Revision 10866, 15.2 kB (checked in by robert, 5 years ago)

From Sukender, "I experienced as some users before: I tried to rescale an image without a valid rendering context... And had problems to unserstand what the "GL_OUT_OF_MEMORY" meant! So I added a few comments for future users."

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under 
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version.  The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_IMAGE
15#define OSG_IMAGE 1
16
17#include <osg/BufferObject>
18#include <osg/Vec2>
19#include <osg/Vec3>
20#include <osg/Vec4>
21#include <osg/FrameStamp>
22
23#include <string>
24#include <vector>
25
26#ifndef GL_VERSION_1_2
27    // 1.2 definitions...
28    #define GL_BGR                          0x80E0
29    #define GL_BGRA                         0x80E1
30    #define GL_UNSIGNED_BYTE_3_3_2          0x8032
31    #define GL_UNSIGNED_BYTE_2_3_3_REV      0x8362
32    #define GL_UNSIGNED_SHORT_5_6_5         0x8363
33    #define GL_UNSIGNED_SHORT_5_6_5_REV     0x8364
34    #define GL_UNSIGNED_SHORT_4_4_4_4       0x8033
35    #define GL_UNSIGNED_SHORT_4_4_4_4_REV   0x8365
36    #define GL_UNSIGNED_SHORT_5_5_5_1       0x8034
37    #define GL_UNSIGNED_SHORT_1_5_5_5_REV   0x8366
38    #define GL_UNSIGNED_INT_8_8_8_8         0x8035
39    #define GL_UNSIGNED_INT_8_8_8_8_REV     0x8367
40    #define GL_UNSIGNED_INT_10_10_10_2      0x8036
41    #define GL_UNSIGNED_INT_2_10_10_10_REV  0x8368
42#endif
43
44#ifndef GL_COMPRESSED_ALPHA
45    #define GL_COMPRESSED_ALPHA             0x84E9
46    #define GL_COMPRESSED_LUMINANCE         0x84EA
47    #define GL_COMPRESSED_LUMINANCE_ALPHA   0x84EB
48    #define GL_COMPRESSED_INTENSITY         0x84EC
49    #define GL_COMPRESSED_RGB               0x84ED
50    #define GL_COMPRESSED_RGBA              0x84EE
51#endif
52
53
54#ifndef GL_ABGR_EXT
55#define GL_ABGR_EXT                         0x8000
56#endif
57
58namespace osg {
59
60// forward declare
61class NodeVisitor;
62
63/** Image class for encapsulating the storage texture image data. */
64class OSG_EXPORT Image : public BufferData
65{
66
67    public :
68
69        Image();
70       
71        /** Copy constructor using CopyOp to manage deep vs shallow copy. */
72        Image(const Image& image,const CopyOp& copyop=CopyOp::SHALLOW_COPY);
73
74        virtual Object* cloneType() const { return new Image(); }
75        virtual Object* clone(const CopyOp& copyop) const { return new Image(*this,copyop); }
76        virtual bool isSameKindAs(const Object* obj) const { return dynamic_cast<const Image*>(obj)!=0; }
77        virtual const char* libraryName() const { return "osg"; }
78        virtual const char* className() const { return "Image"; }
79
80        virtual const GLvoid*   getDataPointer() const { return data(); }
81        virtual unsigned int    getTotalDataSize() const { return getTotalSizeInBytesIncludingMipmaps(); }
82
83        /** Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. */
84        virtual int compare(const Image& rhs) const;
85
86        void setFileName(const std::string& fileName);
87        inline const std::string& getFileName() const { return _fileName; }
88       
89        enum WriteHint {
90            NO_PREFERENCE,
91            STORE_INLINE,
92            EXTERNAL_FILE
93        };
94       
95        void setWriteHint(WriteHint writeHint) { _writeHint = writeHint; }
96        WriteHint getWriteHint() const { return _writeHint; }
97       
98        enum AllocationMode {
99            NO_DELETE,
100            USE_NEW_DELETE,
101            USE_MALLOC_FREE
102        };
103       
104        /** Set the method used for deleting data once it goes out of scope. */
105        void setAllocationMode(AllocationMode mode) { _allocationMode = mode; }
106
107        /** Get the method used for deleting data once it goes out of scope. */
108        AllocationMode getAllocationMode() const { return _allocationMode; }
109
110
111        /** Allocate a pixel block of specified size and type. */
112        virtual void allocateImage(int s,int t,int r,
113                           GLenum pixelFormat,GLenum type,
114                           int packing=1);
115       
116       
117        /** Set the image dimensions, format and data. */
118        virtual void setImage(int s,int t,int r,
119                      GLint internalTextureformat,
120                      GLenum pixelFormat,GLenum type,
121                      unsigned char* data,
122                      AllocationMode mode,
123                      int packing=1);
124           
125        /** Read pixels from current frame buffer at specified position and size, using glReadPixels.
126          * Create memory for storage if required, reuse existing pixel coords if possible.
127        */
128        virtual void readPixels(int x,int y,int width,int height,
129                        GLenum pixelFormat,GLenum type);
130           
131
132        /** Read the contents of the current bound texture, handling compressed pixelFormats if present.
133          * Create memory for storage if required, reuse existing pixel coords if possible.
134        */
135        virtual void readImageFromCurrentTexture(unsigned int contextID, bool copyMipMapsIfAvailable, GLenum type = GL_UNSIGNED_BYTE);
136
137
138        /** Scale image to specified size.
139          * \warning The method uses gluScaleImage() and thus needs a valid rendering context.
140        */
141        void scaleImage(int s,int t,int r) { scaleImage(s,t,r, getDataType()); }
142
143        /** Scale image to specified size and with specified data type.
144          * \warning The method uses gluScaleImage() and thus needs a valid rendering context.
145        */
146        virtual void scaleImage(int s,int t,int r, GLenum newDataType);
147
148        /** Copy a source Image into a subpart of this Image at specified position.
149          * Typically used to copy to an already allocated image, such as creating
150          * a 3D image from a stack 2D images.
151          * If this Image is empty then image data is created to
152          * accomodate the source image in its offset position.
153          * If source is NULL then no operation happens, this Image is left unchanged.
154        */
155        virtual void copySubImage(int s_offset, int t_offset, int r_offset, const osg::Image* source);
156
157
158        enum Origin
159        {
160            BOTTOM_LEFT,
161            TOP_LEFT
162        };
163       
164        /** Set the origin of the image.
165          * The default value is BOTTOM_LEFT and is consistent with OpenGL.
166          * TOP_LEFT is used for imagery that follows standard Imagery convention, such as movies,
167          * and hasn't been flipped yet.  For such images one much flip the t axis of the tex coords.
168          * to handle this origin position. */
169        void setOrigin(Origin origin) { _origin = origin; }
170       
171        /** Get the origin of the image.*/
172        Origin getOrigin() const { return _origin; }
173       
174
175        /** Width of image. */
176        inline int s() const { return _s; }
177
178        /** Height of image. */
179        inline int t() const { return _t; }
180       
181        /** Depth of image. */
182        inline int r() const { return _r; }
183       
184        void setInternalTextureFormat(GLint internalFormat);
185        inline GLint getInternalTextureFormat() const { return _internalTextureFormat; }
186       
187        void setPixelFormat(GLenum pixelFormat);
188        inline GLenum getPixelFormat() const { return _pixelFormat; }
189       
190        void setDataType(GLenum dataType);
191        inline GLenum getDataType() const { return _dataType; }       
192       
193        void setPacking(unsigned int packing) { _packing = packing; }
194        inline unsigned int getPacking() const { return _packing; }
195
196        /** Set the pixel aspect ratio, defined as the pixel width divided by the pixel height.*/
197        inline void setPixelAspectRatio(float pixelAspectRatio) { _pixelAspectRatio = pixelAspectRatio; }
198
199        /** Get the pixel aspect ratio.*/
200        inline float getPixelAspectRatio() const { return _pixelAspectRatio; }
201       
202        /** Return the number of bits required for each pixel. */
203        inline unsigned int getPixelSizeInBits() const { return computePixelSizeInBits(_pixelFormat,_dataType); }
204
205        /** Return the number of bytes each row of pixels occupies once it has been packed. */
206        inline unsigned int getRowSizeInBytes() const { return computeRowWidthInBytes(_s,_pixelFormat,_dataType,_packing); }
207
208        /** Return the number of bytes each image (_s*_t) of pixels occupies. */
209        inline unsigned int getImageSizeInBytes() const { return getRowSizeInBytes()*_t; }
210       
211        /** Return the number of bytes the whole row/image/volume of pixels occupies. */
212        inline unsigned int getTotalSizeInBytes() const { return getImageSizeInBytes()*_r; }
213
214        /** Return the number of bytes the whole row/image/volume of pixels occupies, including all mip maps if included. */
215        unsigned int getTotalSizeInBytesIncludingMipmaps() const;
216
217        /** Return true if the Image represent a valid and usable imagery.*/
218        bool valid() const { return _s!=0 && _t!=0 && _r!=0 && _data!=0 && _dataType!=0; }
219
220        /** Raw image data. */
221        inline unsigned char* data() { return _data; }
222       
223        /** Raw const image data. */
224        inline const unsigned char* data() const { return _data; }
225
226
227        inline unsigned char* data(int column, int row=0,int image=0)
228        {
229            if (!_data) return NULL;
230            return _data+(column*getPixelSizeInBits())/8+row*getRowSizeInBytes()+image*getImageSizeInBytes();
231        }
232       
233        inline const unsigned char* data(int column, int row=0,int image=0) const
234        {
235            if (!_data) return NULL;
236            return _data+(column*getPixelSizeInBits())/8+row*getRowSizeInBytes()+image*getImageSizeInBytes();
237        }
238
239        /** Get the color value for specified texcoord.*/
240        Vec4 getColor(unsigned int s,unsigned t=0,unsigned r=0) const;
241
242        /** Get the color value for specified texcoord.*/
243        Vec4 getColor(const Vec2& texcoord) const { return getColor(Vec3(texcoord.x(),texcoord.y(),0.0f)); }
244
245        /** Get the color value for specified texcoord.*/
246        Vec4 getColor(const Vec3& texcoord) const;
247
248
249        /** Flip the image horizontally. */
250        void flipHorizontal();
251       
252        /** Flip the image vertically. */
253        void flipVertical();
254
255
256        /** Ensure image dimensions are a power of two.
257          * Mipmapped textures require the image dimensions to be
258          * power of two and are within the maxiumum texture size for
259          * the host machine.
260        */
261        void ensureValidSizeForTexturing(GLint maxTextureSize);
262
263        static bool isPackedType(GLenum type);
264        static GLenum computePixelFormat(GLenum pixelFormat);
265        static GLenum computeFormatDataType(GLenum pixelFormat);
266        static unsigned int computeNumComponents(GLenum pixelFormat);
267        static unsigned int computePixelSizeInBits(GLenum pixelFormat,GLenum type);
268        static unsigned int computeRowWidthInBytes(int width,GLenum pixelFormat,GLenum type,int packing);
269        static int computeNearestPowerOfTwo(int s,float bias=0.5f);
270        static int computeNumberOfMipmapLevels(int s,int t = 1, int r = 1);
271               
272        /** Precomputed mipmaps stuff. */
273        typedef std::vector< unsigned int > MipmapDataType;
274
275        inline bool isMipmap() const {return !_mipmapData.empty();};
276
277        unsigned int getNumMipmapLevels() const
278        {
279            return static_cast<unsigned int>(_mipmapData.size())+1;
280        };
281
282        /** Send offsets into data. It is assumed that first mipmap offset (index 0) is 0.*/
283        inline void setMipmapLevels(const MipmapDataType& mipmapDataVector) { _mipmapData = mipmapDataVector; }
284       
285        inline const MipmapDataType& getMipmapLevels() const { return _mipmapData; }
286
287        inline unsigned int getMipmapOffset(unsigned int mipmapLevel) const
288        {
289            if(mipmapLevel == 0)
290                return 0;
291            else if (mipmapLevel < getNumMipmapLevels())
292               return _mipmapData[mipmapLevel-1];
293            return 0;
294        };
295       
296        inline unsigned char* getMipmapData(unsigned int mipmapLevel)
297        {
298           return _data+getMipmapOffset(mipmapLevel);
299        }
300
301        inline const unsigned char* getMipmapData(unsigned int mipmapLevel) const
302        {
303           return _data+getMipmapOffset(mipmapLevel);
304        }
305
306        /*inline const unsigned char* getMipmapData(unsigned int row, unsigned int column, unsigned int mipmapLevel) const
307        {
308           if (!_data) return NULL;
309           return getMipmapData(mipmapLevel) + (column*getPixelSizeInBits())/8+row*getRowSizeInBytes();
310        }*/
311
312        /** Return true if this image is translucent - i.e. it has alpha values that are less 1.0 (when normalized). */
313        virtual bool isImageTranslucent() const;
314
315        /** Set the optional PixelBufferObject used to map the image memory efficiently to graphics memory. */
316        void setPixelBufferObject(PixelBufferObject* buffer) { setBufferObject(buffer); }
317
318        /** Get the PixelBufferObject.*/
319        PixelBufferObject* getPixelBufferObject() { return dynamic_cast<PixelBufferObject*>(_bufferObject.get()); }
320
321        /** Get the const PixelBufferObject.*/
322        const PixelBufferObject* getPixelBufferObject() const { return dynamic_cast<const PixelBufferObject*>(_bufferObject.get()); }
323       
324        virtual void update(NodeVisitor* /*nv*/) {}
325
326        /** method for sending pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window.  Return true if handled. */
327        virtual bool sendPointerEvent(int /*x*/, int /*y*/, int /*buttonMask*/) { return false; }
328
329        /** method for sending key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window.  Return true if handled.*/
330        virtual bool sendKeyEvent(int /*key*/, bool /*keyDown*/) { return false; }
331
332        /** method for passing frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.*/
333        virtual void setFrameLastRendered(const osg::FrameStamp* /*frameStamp*/) {}
334
335    protected :
336
337        virtual ~Image();
338
339        Image& operator = (const Image&) { return *this; }
340
341        std::string _fileName;
342        WriteHint   _writeHint;
343
344
345        Origin _origin;
346
347        int _s, _t, _r;
348        GLint _internalTextureFormat;
349        GLenum _pixelFormat;
350        GLenum _dataType;
351        unsigned int _packing;
352        float _pixelAspectRatio;
353
354        AllocationMode _allocationMode;
355        unsigned char* _data;
356       
357        void deallocateData();
358       
359        void setData(unsigned char* data,AllocationMode allocationMode);
360
361        MipmapDataType _mipmapData;
362       
363        ref_ptr<PixelBufferObject> _bufferObject;
364};
365
366class Geode;
367
368/** Convenience function to be used by image loaders to generate a valid geode
369  * to return for readNode().
370  * Use the image's s and t values to scale the dimensions of the image.
371*/
372extern OSG_EXPORT Geode* createGeodeForImage(Image* image);
373/** Convenience function to be used by image loaders to generate a valid geode
374  * to return for readNode().
375  * Use the specified s and t values to scale the dimensions of the image.
376*/
377extern OSG_EXPORT Geode* createGeodeForImage(Image* image,float s,float t);
378
379}
380
381#endif                                            // __SG_IMAGE_H
Note: See TracBrowser for help on using the browser.