rSurface Class Reference

wrapper for SDL surface More...

#include <rTexture.h>

List of all members.

Public Member Functions
	rSurface (char const *fileName, tPath const *path=&tDirectories::Data())
	constructor creating the surface from a file
	~rSurface ()
	destructor
	rSurface (rSurface const &other)
	copy constructor
rSurface &	operator= (rSurface const &other)
	copy operator
SDL_Surface *	GetSurface (void) const
	Gets the surface itself.
rSurface const &	GetSurface (SDL_Surface *&surface) const
	Gets the surface itself.
GLenum const &	GetFormat (void) const
	Gets openGL texture format to use.
rSurface const &	GetFormat (GLenum &format) const
	Gets openGL texture format to use.
Protected Member Functions
	rSurface ()
	default constructor, not creating a real surface
void	Init ()
	initialize data members
void	Clear ()
	destroys data members
void	Create (char const *fileName, tPath const *path=&tDirectories::Data())
	create surface from file
void	Create (SDL_Surface *surface)
	take ownership of surface
rSurface &	SetSurface (SDL_Surface *surface)
	Sets the surface itself.
rSurface &	SetFormat (GLenum const &format)
	Sets openGL texture format to use.
Private Member Functions
void	CopyFrom (rSurface const &other)
	copy function
Private Attributes
SDL_Surface *	surface_
	the surface itself
GLenum	format_
	OpenGL texture format to use.

---

Detailed Description

wrapper for SDL surface

Definition at line 60 of file rTexture.h.

---

Constructor & Destructor Documentation

rSurface::rSurface	(	char const *	fileName,
		tPath const *	path = &tDirectories::Data()
	)			[explicit]

constructor creating the surface from a file

Parameters:

fileName

name of the file to load sufrace from

Definition at line 101 of file rTexture.cpp.

References Create(), and Init().

{
    Init();
    Create( fileName, path );
}

Here is the call graph for this function:

rSurface::~rSurface

(

void

)

destructor

Definition at line 116 of file rTexture.cpp.

References Clear().

{
    Clear();
}

Here is the call graph for this function:

rSurface::rSurface

(

rSurface const &

other

)

copy constructor

Parameters:

other

source to copy from

Definition at line 145 of file rTexture.cpp.

References CopyFrom(), and Init().

{
    Init();
    CopyFrom( other );
}

Here is the call graph for this function:

rSurface::rSurface

(

void

)

[protected]

default constructor, not creating a real surface

Definition at line 130 of file rTexture.cpp.

References Init().

{
    Init();
}

Here is the call graph for this function:

---

Member Function Documentation

rSurface & rSurface::operator=

(

rSurface const &

other

)

copy operator

Parameters:

other

Returns:

Definition at line 162 of file rTexture.cpp.

References Clear(), and CopyFrom().

{
    if ( &other != this )
    {
        Clear();
        CopyFrom( other );
    }

    return *this;
}

Here is the call graph for this function:

void rSurface::Init

(

void

)

[protected]

initialize data members

Definition at line 182 of file rTexture.cpp.

References format_, and surface_.

Referenced by rSurface().

{
    surface_ = 0;
    format_ = 0;
}

Here is the caller graph for this function:

void rSurface::Clear

(

void

)

[protected]

destroys data members

Definition at line 197 of file rTexture.cpp.

References surface_.

Referenced by Create(), operator=(), and ~rSurface().

{
#ifndef DEDICATED
    // delete surface
    if ( surface_ )
        SDL_FreeSurface( surface_ );

#endif
    surface_ = 0;
}

Here is the caller graph for this function:

void rSurface::Create	(	char const *	fileName,
		tPath const *	path = &tDirectories::Data()
	)			[protected]

create surface from file

Parameters:

fileName

name of the image file to load

Definition at line 218 of file rTexture.cpp.

References tPath::GetReadPath(), sr_LockSDL(), and sr_UnlockSDL().

Referenced by rSurface().

{
#ifndef DEDICATED
    sr_LockSDL();

    IMG_InvertAlpha(true);

    // find path of image and load it
    SDL_Surface *surface;
    if(path) {
        tString s = path->GetReadPath( fileName );
        surface = IMG_Load(s);
    } else {
        surface = IMG_Load(fileName);
    }
    Create(surface);

    //if ( surface_ )
    //    std::cerr << "loaded surface " << fileName << "\n";

    sr_UnlockSDL();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void rSurface::Create

(

SDL_Surface *

surface

)

[protected]

take ownership of surface

Parameters:

surface

Definition at line 252 of file rTexture.cpp.

References Clear(), format_, and surface_.

{
#ifndef DEDICATED
    // clear previous surface
    Clear();

    // take ownership
    surface_ = surface;

    // determine texture format
    if ( surface_ )
    {
        switch (surface_->format->BytesPerPixel){
        case 1:
            format_ = GL_LUMINANCE;
            break;

        case 2:
            format_ = GL_LUMINANCE8_ALPHA8;
            break;

        case 3:
            format_ = GL_RGB;
            break;

        case 4:
            format_ = GL_RGBA;
            break;

        default:
            {
                // fallback: convert the texture into a known format.

                SDL_Surface *dummy =
                    SDL_CreateRGBSurface(SDL_SWSURFACE, 1, 1,
                                         32,
                                         0x0000FF, 0x00FF00,
                                         0xFF0000 ,0xFF000000);

                SDL_Surface *convtex =
                    SDL_ConvertSurface(surface_, dummy->format, SDL_SWSURFACE);

                SDL_FreeSurface(surface_);
                surface_ = convtex;
                SDL_FreeSurface(dummy);

                format_ = GL_RGBA;
            }
            break;
        }
    }
#endif
}

Here is the call graph for this function:

void rSurface::CopyFrom

(

rSurface const &

other

)

[private]

copy function

Parameters:

other

Definition at line 316 of file rTexture.cpp.

References format_, surface_, and tASSERT.

Referenced by operator=(), and rSurface().

{
#ifndef DEDICATED
    tASSERT( 0 == surface_ );
    tASSERT( other.surface_ );

    // copy surface
    surface_ = SDL_ConvertSurface(other.surface_, other.surface_->format, SDL_SWSURFACE);

    // copy flags
    format_ = other.format_;
#endif
}

Here is the caller graph for this function:

SDL_Surface * rSurface::GetSurface

(

void

)

const [inline]

Gets the surface itself.

Returns:

the surface itself

Definition at line 260 of file rTexture.h.

References surface_.

Referenced by rSurfaceTexture::OnSelect(), rFileTexture::OnSelect(), sg_SetIcon(), and rISurfaceTexture::Upload().

{
    return this->surface_;
}

Here is the caller graph for this function:

rSurface const & rSurface::GetSurface

(

SDL_Surface *&

surface

)

const [inline]

Gets the surface itself.

Parameters:

surface

the surface itself to fill

Returns:

A reference to this to allow chaining

Definition at line 276 of file rTexture.h.

References surface_.

{
    surface = this->surface_;
    return *this;
}

GLenum const & rSurface::GetFormat

(

void

)

const [inline]

Gets openGL texture format to use.

Returns:

OpenGL texture format to use

Definition at line 309 of file rTexture.h.

References format_.

Referenced by rISurfaceTexture::Upload().

{
    return this->format_;
}

Here is the caller graph for this function:

rSurface const & rSurface::GetFormat

(

GLenum &

format

)

const [inline]

Gets openGL texture format to use.

Parameters:

format

OpenGL texture format to use to fill

Returns:

A reference to this to allow chaining

Definition at line 325 of file rTexture.h.

References format_.

{
    format = this->format_;
    return *this;
}

rSurface & rSurface::SetSurface

(

SDL_Surface *

surface

)

[inline, protected]

Sets the surface itself.

Parameters:

surface

the surface itself to set

Returns:

A reference to this to allow chaining

Definition at line 293 of file rTexture.h.

References surface_.

{
    this->surface_ = surface;
    return *this;
}

rSurface & rSurface::SetFormat

(

GLenum const &

format

)

[inline, protected]

Sets openGL texture format to use.

Parameters:

format

OpenGL texture format to use to set

Returns:

A reference to this to allow chaining

Definition at line 342 of file rTexture.h.

References format_.

{
    this->format_ = format;
    return *this;
}

---

Member Data Documentation

SDL_Surface* rSurface::surface_ [private]

the surface itself

Definition at line 76 of file rTexture.h.

Referenced by Clear(), CopyFrom(), Create(), GetSurface(), Init(), and SetSurface().

GLenum rSurface::format_ [private]

OpenGL texture format to use.

Definition at line 77 of file rTexture.h.

Referenced by CopyFrom(), Create(), GetFormat(), Init(), and SetFormat().

---

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

• src/render/rTexture.h
• src/render/rTexture.cpp

---