CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

csProcTexture::eiTextureWrapper Struct Reference

Inheritance diagram for csProcTexture::eiTextureWrapper:

iTextureWrapper iBase List of all members.

Public Member Functions

virtual iTextureWrapperClone () const
 Create a clone this texture wrapper, using the same texture handle.
virtual int GetFlags () const
 Return the flags which are used to register the texture.
virtual iImageGetImageFile ()
 Get the iImage.
virtual void GetKeyColor (int &red, int &green, int &blue) const
 Query the transparent color.
virtual const char * GetTextureClass ()
 Get the "class" of this texture.
virtual iTextureHandleGetTextureHandle ()
 Get the texture handle.
virtual iTextureCallbackGetUseCallback () const
 Get the use callback.
virtual bool IsVisitRequired () const
 Return true if it is needed to call Visit().
virtual bool KeepImage () const
 If this flag is true then the image will be kept even after calling Register.
virtual iObjectQueryObject ()
 Get the iObject for this texture.
virtual void Register (iTextureManager *txtmng)
 Register the texture with the texture manager.
virtual void SetFlags (int flags)
 Set the flags which are used to register the texture.
virtual void SetImageFile (iImage *Image)
 Change the base iImage.
virtual void SetKeepImage (bool k)
 Set the keep image flag.
virtual void SetKeyColor (int red, int green, int blue)
 Set the transparent color.
virtual void SetTextureClass (const char *className)
 Set the "class" of this texture.
virtual void SetTextureHandle (iTextureHandle *tex)
 Change the texture handle.
virtual void SetUseCallback (iTextureCallback *callback)
 Set a callback which is called just before the texture is used.
virtual void Visit ()
 Visit this texture.

Detailed Description

Definition at line 100 of file proctex.h.


Member Function Documentation

virtual iTextureWrapper* csProcTexture::eiTextureWrapper::Clone  )  const [virtual]
 

Create a clone this texture wrapper, using the same texture handle.

Implements iTextureWrapper.

virtual int csProcTexture::eiTextureWrapper::GetFlags  )  const [virtual]
 

Return the flags which are used to register the texture.

Implements iTextureWrapper.

virtual iImage* csProcTexture::eiTextureWrapper::GetImageFile  )  [virtual]
 

Get the iImage.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::GetKeyColor int &  red,
int &  green,
int &  blue
const [virtual]
 

Query the transparent color.

Implements iTextureWrapper.

virtual const char* csProcTexture::eiTextureWrapper::GetTextureClass  )  [virtual]
 

Get the "class" of this texture.

For more information, see iTextureHandle::GetTextureClass.

Implements iTextureWrapper.

virtual iTextureHandle* csProcTexture::eiTextureWrapper::GetTextureHandle  )  [virtual]
 

Get the texture handle.

Implements iTextureWrapper.

virtual iTextureCallback* csProcTexture::eiTextureWrapper::GetUseCallback  )  const [virtual]
 

Get the use callback.

If there are multiple use callbacks you can use this function to chain.

Implements iTextureWrapper.

virtual bool csProcTexture::eiTextureWrapper::IsVisitRequired  )  const [virtual]
 

Return true if it is needed to call Visit().

Implements iTextureWrapper.

virtual bool csProcTexture::eiTextureWrapper::KeepImage  )  const [virtual]
 

If this flag is true then the image will be kept even after calling Register.

If this flag is false then Register() will remove the image pointer from this texture wrapper. False by default.

Implements iTextureWrapper.

virtual iObject* csProcTexture::eiTextureWrapper::QueryObject  )  [virtual]
 

Get the iObject for this texture.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::Register iTextureManager txtmng  )  [virtual]
 

Register the texture with the texture manager.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetFlags int  flags  )  [virtual]
 

Set the flags which are used to register the texture.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetImageFile iImage Image  )  [virtual]
 

Change the base iImage.

The changes will not be visible until the texture is registered again.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetKeepImage bool  k  )  [virtual]
 

Set the keep image flag.

See KeepImage() function for explanation.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetKeyColor int  red,
int  green,
int  blue
[virtual]
 

Set the transparent color.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetTextureClass const char *  className  )  [virtual]
 

Set the "class" of this texture.

For more information, see iTextureHandle::SetTextureClass.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetTextureHandle iTextureHandle tex  )  [virtual]
 

Change the texture handle.

The changes will immediatly be visible. This will also change the key color and registration flags to those of the new texture and the iImage to 0.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::SetUseCallback iTextureCallback callback  )  [virtual]
 

Set a callback which is called just before the texture is used.

This is mainly useful for procedural textures which can then choose to update their image.

Implements iTextureWrapper.

virtual void csProcTexture::eiTextureWrapper::Visit  )  [virtual]
 

Visit this texture.

This should be called by the engine right before using the texture. It is responsible for calling the use callback if there is one.

Implements iTextureWrapper.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.4.4