render/buffer.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004-2007 by Reality Rift Studios                       *
 *   http://www.realityrift.com  -  mattias@realityrift.com                *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef neo_render_buffer_h
#define neo_render_buffer_h

#include "../core/platform.h"
#include "../core/refcount.h"
#include "../core/exception.h"
#include "../core/util.h"

namespace neo {
namespace render {

class Buffer;
    
class BufferLockException : public core::Exception
{
    public:

                                                            BufferLockException( const char *p_msg );
};

class BufferReadLock
{
    public:
    

                                                            BufferReadLock( Buffer* p_buffer );
    
                                                           ~BufferReadLock();
                                                           
                                                           
    private:

    Buffer*                                                 _p_buffer;
                                                           
    bool                                                    _ownLock;
};

class Buffer : public core::Noncopyable, public core::RefCount
{
    public:

    enum Type
    {
        DYNAMIC                                             = 0x00000001,

        STATIC                                              = 0x00000002,

        READPRI                                             = 0x00000004,

        WRITEPRI                                            = 0x00000008,

        NOREADWRITE                                         = 0x00000010,

        NORENDER                                            = 0x00000020,

        NOSYSRAM                                            = 0x00000040,

        DEFAULTTYPE                                         = ( DYNAMIC | READPRI | WRITEPRI )
    };

    enum UploadPolicy
    {
        ONUNLOCK,

        ONRENDER,

        ONFLUSH
    };

    enum Lock
    {
        READ                                                = 0x00000001,

        WRITE                                               = 0x00000002,

        NOUPLOAD                                            = 0x00000004,

        FORCEUPLOAD                                         = 0x00000008
    };


                                                            Buffer( unsigned int type = DEFAULTTYPE );


    void                                                    lock( unsigned int lock );


    inline void                                             unlock();


    virtual void                                            upload();


    inline bool                                             isLocked() const;


    inline bool                                             isDirty() const;


    inline void*                                            getElement( unsigned int element = 0 );


    inline unsigned int                                     getElementSize() const;


    inline unsigned int                                     getType() const;


    inline unsigned int                                     getNumAllocated() const;


    inline unsigned int                                     getNumElements() const;


    inline void                                             setNumElements( unsigned int elements );

    inline bool                                             getStaticSort() const;


    static inline UploadPolicy                              getUploadPolicy();


    static void                                             setUploadPolicy( UploadPolicy policy );


    static void                                             enforceNoRW( bool enforce );

    protected:

    static UploadPolicy                                     _uploadpolicy;

    static bool                                             _enforceNoRW;

    unsigned int                                            _type;

    unsigned int                                            _lock;

    bool                                                    _dirty;

    unsigned int                                            _allocated;

    unsigned int                                            _current;

    unsigned int                                            _size;

    unsigned char*                                          _p_buffer;

    unsigned char*                                          _p_rw;

    bool                                                    _staticsort;


    virtual                                                ~Buffer();

    virtual void                                            acquireLock() = 0;

    virtual void                                            releaseLock() = 0;
};

#include "buffer.inl"

}
}

#endif

---