Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::graphics::io::TextureTranscoder Class Reference

A class that reads and writes textures. More...

#include <omGraphicsTextureTranscoder.h>

Inheritance diagram for om::graphics::io::TextureTranscoder:
om::resources::ResourceTypeTranscoder< DataType > om::resources::ResourceTranscoder

Public Member Functions

 TextureTranscoder (const images::ImageFormat &imageFormat)
 Create a new texture transcoder that loads the specified image type. More...
 
virtual const ResourceFormatgetResourceFormat () const
 Return an object that represents the resource format that this transcoder can read and write. More...
 
virtual Bool canEncode (const Texture &texture) const
 Return whether or not this texture transcoder is able to encode the specified resource. More...
 
virtual Bool encode (const ResourceID &identifier, const Texture &texture, const ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))
 Encode the specified texture to the file at the specified path. More...
 
virtual Bool canDecode (const ResourceID &identifier) const
 Return whether or not the specified identifier refers to a valid OBJ file for this transcoder. More...
 
virtual Texturedecode (ResourceID &identifier, ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))
 Decode the texture file at the specified path and return a pointer to the decoded texture. More...
 
- Public Member Functions inherited from om::resources::ResourceTypeTranscoder< DataType >
virtual const ResourceTypegetResourceType () const
 Return an object that represents the resource type that this transcoder can read and write. More...
 
virtual Bool canEncode (const DataType &resource) const =0
 Return whether or not this transcoder is able to encode the specified resource. More...
 
virtual Bool encode (const ResourceID &identifier, const DataType &resource, const ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))=0
 Save the specified resource object at the specified ID location. More...
 
- Public Member Functions inherited from om::resources::ResourceTranscoder
virtual ~ResourceTranscoder ()
 Destroy a resource transcoder and release all of its resources. More...
 

Detailed Description

A class that reads and writes textures.

Constructor & Destructor Documentation

om::graphics::io::TextureTranscoder::TextureTranscoder ( const images::ImageFormat imageFormat)

Create a new texture transcoder that loads the specified image type.

Member Function Documentation

virtual const ResourceFormat& om::graphics::io::TextureTranscoder::getResourceFormat ( ) const
virtual

Return an object that represents the resource format that this transcoder can read and write.

Implements om::resources::ResourceTranscoder.

virtual Bool om::graphics::io::TextureTranscoder::canEncode ( const Texture texture) const
virtual

Return whether or not this texture transcoder is able to encode the specified resource.

virtual Bool om::graphics::io::TextureTranscoder::encode ( const ResourceID identifier,
const Texture texture,
const ResourceSet resourceSet = ((void *) 0),
ResourceManager manager = ((void *) 0) 
)
virtual

Encode the specified texture to the file at the specified path.

If the method fails, FALSE is returned.

virtual Bool om::graphics::io::TextureTranscoder::canDecode ( const ResourceID identifier) const
virtual

Return whether or not the specified identifier refers to a valid OBJ file for this transcoder.

Implements om::resources::ResourceTranscoder.

virtual Texture* om::graphics::io::TextureTranscoder::decode ( ResourceID identifier,
ResourceSet resourceSet = ((void *) 0),
ResourceManager manager = ((void *) 0) 
)
virtual

Decode the texture file at the specified path and return a pointer to the decoded texture.

If the method fails, a NULL pointer is returned.

Implements om::resources::ResourceTypeTranscoder< DataType >.


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