OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Image Class Reference

#include <Image.h>

Inheritance diagram for osg::Image:
Inheritance graph
[legend]
Collaboration diagram for osg::Image:
Collaboration graph
[legend]

Classes

class  DataIterator
 
class  DimensionsChangedCallback
 
struct  UpdateCallback
 

Public Types

enum  WriteHint { NO_PREFERENCE, STORE_INLINE, EXTERNAL_FILE }
 
enum  AllocationMode { NO_DELETE, USE_NEW_DELETE, USE_MALLOC_FREE }
 
enum  Origin { BOTTOM_LEFT, TOP_LEFT }
 
typedef std::vector< unsigned int > MipmapDataType
 
typedef std::vector
< osg::ref_ptr
< DimensionsChangedCallback > > 		DimensionsChangedCallbackVector
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Image ()
 
 Image (const Image &image, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual Object * cloneType () const
 
virtual Object * clone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual osg::Image * asImage ()
 
virtual const osg::Image * asImage () const
 
virtual const GLvoid * getDataPointer () const
 
virtual unsigned int getTotalDataSize () const
 
virtual int compare (const Image &rhs) const
 
void setFileName (const std::string &fileName)
 
const std::string & getFileName () const
 
void setWriteHint (WriteHint writeHint)
 
WriteHint getWriteHint () const
 
void setAllocationMode (AllocationMode mode)
 
AllocationMode getAllocationMode () const
 
virtual void allocateImage (int s, int t, int r, GLenum pixelFormat, GLenum type, int packing=1)
 
virtual void setImage (int s, int t, int r, GLint internalTextureformat, GLenum pixelFormat, GLenum type, unsigned char *data, AllocationMode mode, int packing=1, int rowLength=0)
 
virtual void readPixels (int x, int y, int width, int height, GLenum pixelFormat, GLenum type, int packing=1)
 
virtual void readImageFromCurrentTexture (unsigned int contextID, bool copyMipMapsIfAvailable, GLenum type=GL_UNSIGNED_BYTE, unsigned int face=0)
 
void swap (osg::Image &rhs)
 
void scaleImage (int s, int t, int r)
 
virtual void scaleImage (int s, int t, int r, GLenum newDataType)
 
virtual void copySubImage (int s_offset, int t_offset, int r_offset, const osg::Image *source)
 
void setOrigin (Origin origin)
 
Origin getOrigin () const
 
int s () const
 
int t () const
 
int r () const
 
void setRowLength (int length)
 
int getRowLength () const
 
void setInternalTextureFormat (GLint internalFormat)
 
GLint getInternalTextureFormat () const
 
void setPixelFormat (GLenum pixelFormat)
 
GLenum getPixelFormat () const
 
void setDataType (GLenum dataType)
 
GLenum getDataType () const
 
void setPacking (unsigned int packing)
 
unsigned int getPacking () const
 
bool isCompressed () const
 
void setPixelAspectRatio (float pixelAspectRatio)
 
float getPixelAspectRatio () const
 
unsigned int getPixelSizeInBits () const
 
unsigned int getRowSizeInBytes () const
 
unsigned int getRowStepInBytes () const
 
unsigned int getImageSizeInBytes () const
 
unsigned int getImageStepInBytes () const
 
unsigned int getTotalSizeInBytes () const
 
unsigned int getTotalSizeInBytesIncludingMipmaps () const
 
bool valid () const
 
unsigned char * data ()
 
const unsigned char * data () const
 
unsigned char * data (unsigned int column, unsigned int row=0, unsigned int image=0)
 
const unsigned char * data (unsigned int column, unsigned int row=0, unsigned int image=0) const
 
bool isDataContiguous () const
 
Vec4 getColor (unsigned int s, unsigned t=0, unsigned r=0) const
 
Vec4 getColor (const Vec2 &texcoord) const
 
Vec4 getColor (const Vec3 &texcoord) const
 
void setColor (const osg::Vec4 &color, unsigned int s, unsigned int t=0, unsigned int r=0)
 
void setColor (const osg::Vec4 &color, const osg::Vec2 &texcoord)
 
void setColor (const osg::Vec4 &color, const osg::Vec3 &texcoord)
 
void flipHorizontal ()
 
void flipVertical ()
 
void flipDepth ()
 
void ensureValidSizeForTexturing (GLint maxTextureSize)
 
bool isMipmap () const
 
unsigned int getNumMipmapLevels () const
 
void setMipmapLevels (const MipmapDataType &mipmapDataVector)
 
const MipmapDataType & getMipmapLevels () const
 
unsigned int getMipmapOffset (unsigned int mipmapLevel) const
 
unsigned char * getMipmapData (unsigned int mipmapLevel)
 
const unsigned char * getMipmapData (unsigned int mipmapLevel) const
 
bool supportsTextureSubloading () const
 
virtual bool isImageTranslucent () const
 
void setPixelBufferObject (PixelBufferObject *buffer)
 
PixelBufferObject * getPixelBufferObject ()
 
const PixelBufferObject * getPixelBufferObject () const
 
virtual bool requiresUpdateCall () const
 
virtual void update (NodeVisitor *)
 
virtual bool sendFocusHint (bool)
 
virtual bool sendPointerEvent (int, int, int)
 
virtual bool sendKeyEvent (int, bool)
 
virtual void setFrameLastRendered (const osg::FrameStamp *)
 
void addDimensionsChangedCallback (DimensionsChangedCallback *cb)
 
void removeDimensionsChangedCallback (DimensionsChangedCallback *cb)
 
- Public Member Functions inherited from osg::BufferData
 BufferData ()
 
 BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual osg::Array * asArray ()
 
virtual const osg::Array * asArray () const
 
virtual osg::PrimitiveSet * asPrimitiveSet ()
 
virtual const osg::PrimitiveSet * asPrimitiveSet () const
 
void setBufferObject (BufferObject *bufferObject)
 
BufferObject * getBufferObject ()
 
const BufferObject * getBufferObject () const
 
void setBufferIndex (unsigned int index)
 
unsigned int getBufferIndex () const
 
GLBufferObject * getGLBufferObject (unsigned int contextID) const
 
GLBufferObject * getOrCreateGLBufferObject (unsigned int contextID) const
 
void setModifiedCallback (ModifiedCallback *md)
 
ModifiedCallback * getModifiedCallback ()
 
const ModifiedCallback * getModifiedCallback () const
 
void dirty ()
 
void setModifiedCount (unsigned int value)
 
unsigned int getModifiedCount () const
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
void releaseGLObjects (State *state=0) const
 
unsigned int getNumClients () const
 
void addClient (osg::Object *)
 
void removeClient (osg::Object *)
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual Node * asNode ()
 
virtual const Node * asNode () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 		getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Static Public Member Functions

static bool isPackedType (GLenum type)
 
static GLenum computePixelFormat (GLenum pixelFormat)
 
static GLenum computeFormatDataType (GLenum pixelFormat)
 
static unsigned int computeBlockSize (GLenum pixelFormat, GLenum packing)
 
static unsigned int computeNumComponents (GLenum pixelFormat)
 
static unsigned int computePixelSizeInBits (GLenum pixelFormat, GLenum type)
 
static unsigned int computeRowWidthInBytes (int width, GLenum pixelFormat, GLenum type, int packing)
 
static unsigned int computeImageSizeInBytes (int width, int height, int depth, GLenum pixelFormat, GLenum type, int packing=1, int slice_packing=1, int image_packing=1)
 
static int computeNearestPowerOfTwo (int s, float bias=0.5f)
 
static int computeNumberOfMipmapLevels (int s, int t=1, int r=1)
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

Protected Member Functions

virtual ~Image ()
 
Image & operator= (const Image &)
 
void handleDimensionsChangedCallbacks ()
 
void deallocateData ()
 
void setData (unsigned char *data, AllocationMode allocationMode)
 
- Protected Member Functions inherited from osg::BufferData
virtual ~BufferData ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

std::string _fileName
 
WriteHint _writeHint
 
Origin _origin
 
int _s
 
int _t
 
int _r
 
int _rowLength
 
GLint _internalTextureFormat
 
GLenum _pixelFormat
 
GLenum _dataType
 
unsigned int _packing
 
float _pixelAspectRatio
 
AllocationMode _allocationMode
 
unsigned char * _data
 
MipmapDataType _mipmapData
 
DimensionsChangedCallbackVector _dimensionsChangedCallbacks
 
- Protected Attributes inherited from osg::BufferData
unsigned int _modifiedCount
 
unsigned int _bufferIndex
 
osg::ref_ptr< BufferObject > _bufferObject
 
osg::ref_ptr< ModifiedCallback > _modifiedCallback
 
unsigned int _numClients
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer * _userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Detailed Description

Image class for encapsulating the storage texture image data.

Definition at line 138 of file Image.h.

Member Typedef Documentation

typedef std::vector< osg::ref_ptr<DimensionsChangedCallback> > osg::Image::DimensionsChangedCallbackVector

Definition at line 494 of file Image.h.

typedef std::vector< unsigned int > osg::Image::MipmapDataType

Precomputed mipmaps stuff.

Definition at line 413 of file Image.h.

Member Enumeration Documentation

enum osg::Image::AllocationMode
Enumerator
NO_DELETE 
USE_NEW_DELETE 
USE_MALLOC_FREE 

Definition at line 175 of file Image.h.

enum osg::Image::Origin
Enumerator
BOTTOM_LEFT 
TOP_LEFT 

Definition at line 233 of file Image.h.

enum osg::Image::WriteHint
Enumerator
NO_PREFERENCE 
STORE_INLINE 
EXTERNAL_FILE 

Definition at line 166 of file Image.h.

Constructor & Destructor Documentation

osg::Image::Image ( )
osg::Image::Image ( const Image &  image,
const CopyOp &  copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Image::~Image ( )
protectedvirtual

Member Function Documentation

void osg::Image::addDimensionsChangedCallback ( DimensionsChangedCallback *  cb)
virtual void osg::Image::allocateImage ( int  s,
int  t,
int  r,
GLenum  pixelFormat,
GLenum  type,
int  packing = 1 
)
virtual

Allocate a pixel block of specified size and type.

virtual osg::Image* osg::Image::asImage ( )
inlinevirtual

Reimplemented from osg::BufferData.

Definition at line 154 of file Image.h.

virtual const osg::Image* osg::Image::asImage ( ) const
inlinevirtual

Reimplemented from osg::BufferData.

Definition at line 155 of file Image.h.

virtual const char* osg::Image::className ( ) const
inlinevirtual

return the name of the object's class type. Must be defined by derived classes.

Reimplemented from osg::BufferData.

Reimplemented in osg::ImageSequence, and osg::ImageStream.

Definition at line 152 of file Image.h.

virtual Object* osg::Image::clone ( const CopyOp &  ) const
inlinevirtual

Clone an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osg::ImageSequence, and osg::ImageStream.

Definition at line 149 of file Image.h.

virtual Object* osg::Image::cloneType ( ) const
inlinevirtual

Clone the type of an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osg::ImageSequence, and osg::ImageStream.

Definition at line 148 of file Image.h.

virtual int osg::Image::compare ( const Image &  rhs) const
virtual

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Reimplemented in osg::ImageSequence, and osg::ImageStream.

static unsigned int osg::Image::computeBlockSize ( GLenum  pixelFormat,
GLenum  packing 
)
static
static GLenum osg::Image::computeFormatDataType ( GLenum  pixelFormat)
static
static unsigned int osg::Image::computeImageSizeInBytes ( int  width,
int  height,
int  depth,
GLenum  pixelFormat,
GLenum  type,
int  packing = 1,
int  slice_packing = 1,
int  image_packing = 1 
)
static
static int osg::Image::computeNearestPowerOfTwo ( int  s,
float  bias = 0.5f 
)
static
static int osg::Image::computeNumberOfMipmapLevels ( int  s,
int  t = 1,
int  r = 1 
)
static
static unsigned int osg::Image::computeNumComponents ( GLenum  pixelFormat)
static
static GLenum osg::Image::computePixelFormat ( GLenum  pixelFormat)
static
static unsigned int osg::Image::computePixelSizeInBits ( GLenum  pixelFormat,
GLenum  type 
)
static
static unsigned int osg::Image::computeRowWidthInBytes ( int  width,
GLenum  pixelFormat,
GLenum  type,
int  packing 
)
static
virtual void osg::Image::copySubImage ( int  s_offset,
int  t_offset,
int  r_offset,
const osg::Image *  source 
)
virtual

Copy a source Image into a subpart of this Image at specified position. Typically used to copy to an already allocated image, such as creating a 3D image from a stack 2D images. If this Image is empty then image data is created to accommodate the source image in its offset position. If source is NULL then no operation happens, this Image is left unchanged.

unsigned char* osg::Image::data ( )
inline

Raw image data. Note, data in successive rows may not be contiguous, isDataContiguous() return false then you should take care to access the data per row rather than treating the whole data as a single block.

Definition at line 312 of file Image.h.

Here is the caller graph for this function:

const unsigned char* osg::Image::data ( ) const
inline

Raw const image data. Note, data in successive rows may not be contiguous, isDataContiguous() return false then you should take care to access the data per row rather than treating the whole data as a single block.

Definition at line 317 of file Image.h.

unsigned char* osg::Image::data ( unsigned int  column,
unsigned int  row = 0,
unsigned int  image = 0 
)
inline

Definition at line 319 of file Image.h.

const unsigned char* osg::Image::data ( unsigned int  column,
unsigned int  row = 0,
unsigned int  image = 0 
) const
inline

Definition at line 325 of file Image.h.

void osg::Image::deallocateData ( )
protected
void osg::Image::ensureValidSizeForTexturing ( GLint  maxTextureSize)

Ensure image dimensions are a power of two. Mipmapped textures require the image dimensions to be power of two and are within the maxiumum texture size for the host machine.

void osg::Image::flipDepth ( )

Flip the image around the r dimension. Only relevant for 3D textures.

void osg::Image::flipHorizontal ( )

Flip the image horizontally, around s dimension.

void osg::Image::flipVertical ( )

Flip the image vertically, around t dimension.

AllocationMode osg::Image::getAllocationMode ( ) const
inline

Get the method used for deleting data once it goes out of scope.

Definition at line 185 of file Image.h.

Vec4 osg::Image::getColor ( unsigned int  s,
unsigned  t = 0,
unsigned  r = 0 
) const

Get the color value for specified texcoord.

Vec4 osg::Image::getColor ( const Vec2 &  texcoord) const
inline

Get the color value for specified texcoord.

Definition at line 371 of file Image.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Vec4 osg::Image::getColor ( const Vec3 &  texcoord) const

Get the color value for specified texcoord.

virtual const GLvoid* osg::Image::getDataPointer ( ) const
inlinevirtual

Implements osg::BufferData.

Definition at line 157 of file Image.h.

GLenum osg::Image::getDataType ( ) const
inline

Definition at line 269 of file Image.h.

Here is the caller graph for this function:

const std::string& osg::Image::getFileName ( ) const
inline

Definition at line 164 of file Image.h.

unsigned int osg::Image::getImageSizeInBytes ( ) const
inline

Return the number of bytes each image (_s*_t) of pixels occupies.

Definition at line 294 of file Image.h.

unsigned int osg::Image::getImageStepInBytes ( ) const
inline

Return the number of bytes between each successive image. Note, getImageSizeInBytes() will only equal getImageStepInBytes() when isDataContiguous() return true.

Definition at line 298 of file Image.h.

GLint osg::Image::getInternalTextureFormat ( ) const
inline

Definition at line 263 of file Image.h.

unsigned char* osg::Image::getMipmapData ( unsigned int  mipmapLevel)
inline

Definition at line 436 of file Image.h.

const unsigned char* osg::Image::getMipmapData ( unsigned int  mipmapLevel) const
inline

Definition at line 441 of file Image.h.

const MipmapDataType& osg::Image::getMipmapLevels ( ) const
inline

Definition at line 425 of file Image.h.

unsigned int osg::Image::getMipmapOffset ( unsigned int  mipmapLevel) const
inline

Definition at line 427 of file Image.h.

unsigned int osg::Image::getNumMipmapLevels ( ) const
inline

Definition at line 417 of file Image.h.

Origin osg::Image::getOrigin ( ) const
inline

Get the origin of the image.

Definition at line 247 of file Image.h.

unsigned int osg::Image::getPacking ( ) const
inline

Definition at line 272 of file Image.h.

float osg::Image::getPixelAspectRatio ( ) const
inline

Get the pixel aspect ratio.

Definition at line 281 of file Image.h.

PixelBufferObject* osg::Image::getPixelBufferObject ( )
inline

Get the PixelBufferObject.

Definition at line 456 of file Image.h.

const PixelBufferObject* osg::Image::getPixelBufferObject ( ) const
inline

Get the const PixelBufferObject.

Definition at line 459 of file Image.h.

GLenum osg::Image::getPixelFormat ( ) const
inline

Definition at line 266 of file Image.h.

Here is the caller graph for this function:

unsigned int osg::Image::getPixelSizeInBits ( ) const
inline

Return the number of bits required for each pixel.

Definition at line 284 of file Image.h.

int osg::Image::getRowLength ( ) const
inline

Definition at line 260 of file Image.h.

unsigned int osg::Image::getRowSizeInBytes ( ) const
inline

Return the number of bytes each row of pixels occupies once it has been packed.

Definition at line 287 of file Image.h.

unsigned int osg::Image::getRowStepInBytes ( ) const
inline

Return the number of bytes between each successive row. Note, getRowSizeInBytes() will only equal getRowStepInBytes() when isDataContiguous() return true.

Definition at line 291 of file Image.h.

virtual unsigned int osg::Image::getTotalDataSize ( ) const
inlinevirtual

Implements osg::BufferData.

Definition at line 158 of file Image.h.

unsigned int osg::Image::getTotalSizeInBytes ( ) const
inline

Return the number of bytes the whole row/image/volume of pixels occupies.

Definition at line 301 of file Image.h.

unsigned int osg::Image::getTotalSizeInBytesIncludingMipmaps ( ) const

Return the number of bytes the whole row/image/volume of pixels occupies, including all mip maps if included.

WriteHint osg::Image::getWriteHint ( ) const
inline

Definition at line 173 of file Image.h.

void osg::Image::handleDimensionsChangedCallbacks ( )
inlineprotected

Definition at line 505 of file Image.h.

bool osg::Image::isCompressed ( ) const

Return true of the pixel format is an OpenGL compressed pixel format.

bool osg::Image::isDataContiguous ( ) const
inline

return true if the data stored in the image is a contiguous block of data.

Definition at line 332 of file Image.h.

virtual bool osg::Image::isImageTranslucent ( ) const
virtual

Return true if this image is translucent - i.e. it has alpha values that are less 1.0 (when normalized).

bool osg::Image::isMipmap ( ) const
inline

Definition at line 415 of file Image.h.

static bool osg::Image::isPackedType ( GLenum  type)
static
virtual bool osg::Image::isSameKindAs ( const Object *  obj) const
inlinevirtual

Reimplemented from osg::BufferData.

Reimplemented in osg::ImageSequence, and osg::ImageStream.

Definition at line 150 of file Image.h.

virtual const char* osg::Image::libraryName ( ) const
inlinevirtual

return the name of the object's library. Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Reimplemented from osg::BufferData.

Reimplemented in osg::ImageSequence, and osg::ImageStream.

Definition at line 151 of file Image.h.

Image& osg::Image::operator= ( const Image &  )
inlineprotected

Definition at line 503 of file Image.h.

int osg::Image::r ( ) const
inline

Depth of image.

Definition at line 257 of file Image.h.

Here is the caller graph for this function:

virtual void osg::Image::readImageFromCurrentTexture ( unsigned int  contextID,
bool  copyMipMapsIfAvailable,
GLenum  type = GL_UNSIGNED_BYTE,
unsigned int  face = 0 
)
virtual

Read the contents of the current bound texture, handling compressed pixelFormats if present. Create memory for storage if required, reuse existing pixel coords if possible.

virtual void osg::Image::readPixels ( int  x,
int  y,
int  width,
int  height,
GLenum  pixelFormat,
GLenum  type,
int  packing = 1 
)
virtual

Read pixels from current frame buffer at specified position and size, using glReadPixels. Create memory for storage if required, reuse existing pixel coords if possible.

void osg::Image::removeDimensionsChangedCallback ( DimensionsChangedCallback *  cb)
virtual bool osg::Image::requiresUpdateCall ( ) const
inlinevirtual

Return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image.

Reimplemented in osg::ImageSequence, osgQt::QWebViewImage, and osgQt::QWidgetImage.

Definition at line 462 of file Image.h.

int osg::Image::s ( ) const
inline

Width of image.

Definition at line 251 of file Image.h.

Here is the caller graph for this function:

void osg::Image::scaleImage ( int  s,
int  t,
int  r 
)
inline

Scale image to specified size.

Definition at line 218 of file Image.h.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void osg::Image::scaleImage ( int  s,
int  t,
int  r,
GLenum  newDataType 
)
virtual

Scale image to specified size and with specified data type.

Reimplemented in osgQt::QWidgetImage.

virtual bool osg::Image::sendFocusHint ( bool  )
inlinevirtual

Hint whether to enable or disable focus to images acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.

Reimplemented in osgQt::QWebViewImage, and osgQt::QWidgetImage.

Definition at line 477 of file Image.h.

virtual bool osg::Image::sendKeyEvent ( int  ,
bool   
)
inlinevirtual

Send key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.

Reimplemented in osgQt::QWebViewImage, and osgQt::QWidgetImage.

Definition at line 483 of file Image.h.

virtual bool osg::Image::sendPointerEvent ( int  ,
int  ,
int   
)
inlinevirtual

Send pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.

Reimplemented in osgQt::QWebViewImage, and osgQt::QWidgetImage.

Definition at line 480 of file Image.h.

void osg::Image::setAllocationMode ( AllocationMode  mode)
inline

Set the method used for deleting data once it goes out of scope.

Definition at line 182 of file Image.h.

void osg::Image::setColor ( const osg::Vec4 &  color,
unsigned int  s,
unsigned int  t = 0,
unsigned int  r = 0 
)

Set the color value for specified texcoord.

void osg::Image::setColor ( const osg::Vec4 &  color,
const osg::Vec2 &  texcoord 
)
inline

Set the color value for specified texcoord. Note texcoord is clamped to edge.

Definition at line 380 of file Image.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void osg::Image::setColor ( const osg::Vec4 &  color,
const osg::Vec3 &  texcoord 
)

Set the color value for specified texcoord. Note texcoord is clamped to edge.

void osg::Image::setData ( unsigned char *  data,
AllocationMode  allocationMode 
)
protected
void osg::Image::setDataType ( GLenum  dataType)
void osg::Image::setFileName ( const std::string &  fileName)
virtual void osg::Image::setFrameLastRendered ( const osg::FrameStamp *  )
inlinevirtual

Pass frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.

Reimplemented in osgQt::QWebViewImage, and osgQt::QWidgetImage.

Definition at line 486 of file Image.h.

virtual void osg::Image::setImage ( int  s,
int  t,
int  r,
GLint  internalTextureformat,
GLenum  pixelFormat,
GLenum  type,
unsigned char *  data,
AllocationMode  mode,
int  packing = 1,
int  rowLength = 0 
)
virtual

Set the image dimensions, format and data.

Here is the caller graph for this function:

void osg::Image::setInternalTextureFormat ( GLint  internalFormat)
void osg::Image::setMipmapLevels ( const MipmapDataType &  mipmapDataVector)
inline

Send offsets into data. It is assumed that first mipmap offset (index 0) is 0.

Definition at line 423 of file Image.h.

void osg::Image::setOrigin ( Origin  origin)
inline

Set the origin of the image. The default value is BOTTOM_LEFT and is consistent with OpenGL. TOP_LEFT is used for imagery that follows standard Imagery convention, such as movies, and hasn't been flipped yet. For such images one much flip the t axis of the tex coords. to handle this origin position.

Definition at line 244 of file Image.h.

void osg::Image::setPacking ( unsigned int  packing)
inline

Definition at line 271 of file Image.h.

void osg::Image::setPixelAspectRatio ( float  pixelAspectRatio)
inline

Set the pixel aspect ratio, defined as the pixel width divided by the pixel height.

Definition at line 278 of file Image.h.

void osg::Image::setPixelBufferObject ( PixelBufferObject *  buffer)
inline

Set the optional PixelBufferObject used to map the image memory efficiently to graphics memory.

Definition at line 453 of file Image.h.

void osg::Image::setPixelFormat ( GLenum  pixelFormat)
void osg::Image::setRowLength ( int  length)
void osg::Image::setWriteHint ( WriteHint  writeHint)
inline

Definition at line 172 of file Image.h.

bool osg::Image::supportsTextureSubloading ( ) const

returns false for texture formats that do not support texture subloading

void osg::Image::swap ( osg::Image &  rhs)

swap the data and settings between two image objects.

int osg::Image::t ( ) const
inline

Height of image.

Definition at line 254 of file Image.h.

Here is the caller graph for this function:

virtual void osg::Image::update ( NodeVisitor *  )
inlinevirtual

update method for osg::Image subclasses that update themselves during the update traversal.

Reimplemented in osg::ImageSequence, osgQt::QWebViewImage, and osgQt::QWidgetImage.

Definition at line 465 of file Image.h.

bool osg::Image::valid ( ) const
inline

Return true if the Image represent a valid and usable imagery.

Definition at line 307 of file Image.h.

Here is the caller graph for this function:

Member Data Documentation

AllocationMode osg::Image::_allocationMode
protected

Definition at line 526 of file Image.h.

unsigned char* osg::Image::_data
protected

Definition at line 527 of file Image.h.

GLenum osg::Image::_dataType
protected

Definition at line 522 of file Image.h.

DimensionsChangedCallbackVector osg::Image::_dimensionsChangedCallbacks
protected

Definition at line 535 of file Image.h.

std::string osg::Image::_fileName
protected

Definition at line 513 of file Image.h.

GLint osg::Image::_internalTextureFormat
protected

Definition at line 520 of file Image.h.

MipmapDataType osg::Image::_mipmapData
protected

Definition at line 533 of file Image.h.

Origin osg::Image::_origin
protected

Definition at line 516 of file Image.h.

unsigned int osg::Image::_packing
protected

Definition at line 523 of file Image.h.

float osg::Image::_pixelAspectRatio
protected

Definition at line 524 of file Image.h.

GLenum osg::Image::_pixelFormat
protected

Definition at line 521 of file Image.h.

int osg::Image::_r
protected

Definition at line 518 of file Image.h.

int osg::Image::_rowLength
protected

Definition at line 519 of file Image.h.

int osg::Image::_s
protected

Definition at line 518 of file Image.h.

int osg::Image::_t
protected

Definition at line 518 of file Image.h.

WriteHint osg::Image::_writeHint
protected

Definition at line 514 of file Image.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 4 2016 19:20:50 for OSG by   doxygen 1.8.8