H3D API  2.4.1
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
H3D::DDSImageLoader Class Reference

DDSImageLoader is used to load DirectDraw Surface images (.dds). More...

#include <H3D/DDSImageLoader.h>

Inheritance diagram for H3D::DDSImageLoader:
Inheritance graph

Public Member Functions

 DDSImageLoader ()
 Constructor.
 
virtual ImageloadImage (const string &url)
 Load the image. More...
 
virtual ImageloadImage (istream &is)
 Load an image from an istream. More...
 
- Public Member Functions inherited from H3D::H3DImageLoaderNode
 H3DImageLoaderNode ()
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
- Public Member Functions inherited from H3D::Node
 Node ()
 Constructor.
 
virtual Nodeclone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
 Returns a new instance of this node type with the same state as this one. More...
 
virtual ~Node ()
 Destructor.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...
 
void setProtoInstanceParent (X3DPrototypeInstance *p)
 Set the X3DPrototypeInstance this node is the the root node if applicaple.
 
virtual void render ()
 the render() function is used for the depth-first rendering traversal of the scene-graph. More...
 
virtual void traverseSG (TraverseInfo &ti)
 traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...
 
virtual bool lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
 Detect intersection between a line segment and the Node. More...
 
virtual void closestPoint (const Vec3f &p, NodeIntersectResult &result)
 Find closest point on Node to p. More...
 
virtual bool movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
 Detect collision between a moving sphere and the Node. More...
 
virtual FieldgetField (const string &_name) const
 return a pointer to the field specified by name within this instance
 
int addDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
int removeDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 

Static Public Member Functions

static bool supportsFileType (const string &url)
 Returns true if the node supports the filetype of the file specified by url.
 
static bool supportsStreamType (istream &is)
 Returns true if the node supports the filetype of the file specified by the stream.
 
- Static Public Member Functions inherited from H3D::H3DImageLoaderNode
static H3DImageLoaderNodegetSupportedFileReader (const string &url)
 Given an url to a file, it returns an instance of a H3DImageLoaderNode class that can handle that file type. More...
 
static H3DImageLoaderNodegetSupportedFileReader (istream &is)
 Given an istream, it returns an instance of a H3DImageLoaderNode class that can handle that image type. More...
 
static void registerFileReader (const string &name, CreateNodeFunc create, SupportsFileFunc supports, SupportsStreamFunc supports_stream=NULL)
 Register a file reader that can then be returned by getSupportedFileReader(). More...
 
static void registerFileReader (const FileReaderRegistration &fr)
 Register a file reader that can then be returned by getSupportedFileReader().
 
- Static Public Member Functions inherited from H3D::Node
static unsigned int nrNodesAlive ()
 Returns the nr of nodes currently alive, i.e. nodes created but not destructed.
 
static int nrNodesCreated ()
 Returns the number of nodes created in total since the start of the program.
 

Static Public Attributes

static FileReaderRegistration reader_registration
 Register this node to the H3DSoundFileNodes available.
 

Additional Inherited Members

- Public Types inherited from H3D::H3DImageLoaderNode
typedef bool(* SupportsFileFunc) (const string &url)
 Function ptr type for callback to ask if loader supports a url.
 
typedef bool(* SupportsStreamFunc) (istream &is)
 Function ptr type for callback to ask if loader supports a stream.
 
- Public Types inherited from H3D::Node
typedef std::map< Node *, Node * > DeepCopyMap
 A map type used during a deep copy clone() to map from original nodes to cloned nodes.
 
- Protected Member Functions inherited from H3D::Node
void cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for the clone() method. More...
 
- Static Protected Member Functions inherited from H3D::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

DDSImageLoader is used to load DirectDraw Surface images (.dds).

Note that not all dds formas types are supported yet. Some of the supported formats are dxt1, dxt3 and dxt5. Look in to the implementation of H3DUtil::loadDDSImage in H3DUtil::LoadImageFunctions.h to know exactly which formats are supported.

Examples:

Member Function Documentation

◆ loadImage() [1/2]

virtual Image* H3D::DDSImageLoader::loadImage ( const string &  url)
inlinevirtual

Load the image.

Parameters
urlURL to the file to load.

Implements H3D::H3DImageLoaderNode.

References H3DUtil::loadDDSImage().

◆ loadImage() [2/2]

virtual Image* H3D::DDSImageLoader::loadImage ( istream &  is)
inlinevirtual

Load an image from an istream.

Does not need to be implemented for all image loaders

Returns
An Image * with the image data loaded from the url. Returns NULL if not implemented for image loader.

Reimplemented from H3D::H3DImageLoaderNode.

References H3DUtil::loadDDSImage().


The documentation for this class was generated from the following files: