The Nebula Device 3: Base::StreamTextureSaverBase Class Reference

The Nebula Device 3

Base::StreamTextureSaverBase Class Reference

#include <streamtexturesaverbase.h>

Inheritance diagram for Base::StreamTextureSaverBase:

Resources::ResourceSaver Core::RefCounted Direct3D9::D3D9StreamTextureSaver CoreGraphics::StreamTextureSaver


Detailed Description

Allows to save texture data in a standard file format into a stream.

(C) 2007 Radon Labs GmbH

Public Member Functions

 StreamTextureSaverBase ()
 constructor
virtual ~StreamTextureSaverBase ()
 destructor
void SetStream (const Ptr< IO::Stream > &stream)
 set stream to save to
const Ptr< IO::Stream > & GetStream () const
 get save-stream
void SetFormat (CoreGraphics::ImageFileFormat::Code fmt)
 set file format (default is JPG)
CoreGraphics::ImageFileFormat::Code GetFormat () const
 get file format
void SetMipLevel (IndexT mipLevel)
 set the mip level to save (default is 0, the top level)
IndexT GetMipLevel () const
 get the mip level to save
virtual bool OnSave ()
 called by resource when a save is requested
virtual void OnAttachToResource (const Ptr< Resource > &res)
 called when the resource saver is attached to its resource
virtual void OnRemoveFromResource ()
 called when the resource saver is removed from its resource
bool IsAttachedToResource () const
 return true if attached to resource
const Ptr< Resource > & GetResource () const
 get pointer to resource
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.