IHardwareBuffer.h

// Copyright (C) 2002-2009 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h
 
#ifndef __I_HARDWARE_BUFFER_H_INCLUDED__
#define __I_HARDWARE_BUFFER_H_INCLUDED__
 
#include "IReferenceCounted.h"
#include "EDriverTypes.h"
#include "EHardwareBufferFlags.h"
 
namespace irr
{
namespace video
{
 
enum E_HARDWARE_BUFFER_TYPE
{
    EHBT_NONE=0,
    EHBT_VERTEX,
    EHBT_INDEX,
    EHBT_STREAM_OUTPUT,
    EHBT_SHADER_RESOURCE,
    EHBT_COMPUTE,
    EHBT_CONSTANTS,
    EHBT_SYSTEM
};
 
enum E_HARDWARE_BUFFER_ACCESS
{
    EHBA_DYNAMIC = 0,
    EHBA_DEFAULT,
    EHBA_IMMUTABLE,
    EHBA_SYSTEM_MEMORY
};
 
enum E_HARDWARE_BUFFER_FLAGS
{
    EHBF_INDEX_16_BITS = 1,
    EHBF_INDEX_32_BITS = 1 << 1,
    EHBF_VERTEX_ADDITIONAL_BIND = 1 << 2,
    EHBF_INDEX_ADDITIONAL_BIND = 1 << 3,
    EHBF_SHADER_ADDITIONAL_BIND = 1 << 4,
    EHBF_DRAW_INDIRECT_ARGS = 1 << 5,
    EHBF_COMPUTE_RAW = 1 << 6,
    EHBF_COMPUTE_STRUCTURED = 1 << 7,
    EHBF_COMPUTE_APPEND = 1 << 8,
    EHBF_COMPUTE_CONSUME = 1 << 9
};
 
class IHardwareBuffer : public virtual IReferenceCounted
{
public:
    IHardwareBuffer(const scene::E_HARDWARE_MAPPING mapping, const u32 flags, const u32 size, const E_HARDWARE_BUFFER_TYPE type, const E_DRIVER_TYPE driverType) :
        Mapping(mapping), Flags(flags), Size(size), Type(type), DriverType(driverType), RequiredUpdate(true)
    {
    }
 
    virtual ~IHardwareBuffer()
    {
    }
 
    // Update hardware buffer.
    virtual bool update(const scene::E_HARDWARE_MAPPING mapping, const u32 size, const void* data) = 0;
 
    // Inform if update is required.
    inline bool isRequiredUpdate() const
    {
        return RequiredUpdate;
    }
 
    // Request update.
    inline void requestUpdate()
    {
        RequiredUpdate = true;
    }

    inline scene::E_HARDWARE_MAPPING getMapping() const
    {
        return Mapping;
    }

    inline u32 getFlags() const
    {
        return Flags;
    }

    inline u32 size() const
    {
        return Size;
    }

    inline E_HARDWARE_BUFFER_TYPE getType() const
    {
        return Type;
    }

    inline E_DRIVER_TYPE getDriverType() const
    {
        return DriverType;
    }
 
protected:
    scene::E_HARDWARE_MAPPING Mapping;
    u32 Flags;
    u32 Size;
    E_HARDWARE_BUFFER_TYPE Type;
    E_DRIVER_TYPE DriverType;
 
    bool RequiredUpdate;
};
 
}
}
 
#endif