Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

# Keos::IBufferBase Class Reference

Abstract class for all types of buffers. More...

`#include <KeosBufferBase.h>`

Inheritance diagram for Keos::IBufferBase:

List of all members.

## Public Member Functions

virtual | ~IBufferBase ()
| Destructor.

## Protected Member Functions

| IBufferBase (ulong nCount)
| Default constructor.
virtual void * | Lock (ulong nOffset, ulong nSize, ulong nFlags)=0
| Lock the buffer.
virtual void | Unlock ()=0
| Unlock the buffer.

## Protected Attributes

ulong | m_nCount
| Number of elements in the buffer.

## Friends

class | CBuffer

## Detailed Description

Abstract class for all types of buffers.

Definition at line 32 of file KeosBufferBase.h.

## Constructor & Destructor Documentation

Keos::IBufferBase::~IBufferBase | ( |  | ) | `[virtual]`

| Destructor. Definition at line 38 of file KeosBufferBase.cpp.

Keos::IBufferBase::IBufferBase | ( | ulong | nCount | ) | `[protected]`

| Default constructor.

Parameters:

  | nCount | Number of elements.

Definition at line 31 of file KeosBufferBase.cpp.

## Member Function Documentation

virtual void* Keos::IBufferBase::Lock | ( | ulong | nOffset,
|  | ulong | nSize,
|  | ulong | nFlags
| ) | `[protected, pure virtual]`

| Lock the buffer.

Parameters:

  | nOffset | Lock position.
  | nSize | Number of elements to be locked.
  | nFlags | Lock options.

Returns:
  Pointer on the data locked.

Implemented in Keos::CD3D9Buffer< T >, and Keos::COGLBuffer< Type >.

virtual void Keos::IBufferBase::Unlock | ( |  | ) | `[protected, pure virtual]`

| Unlock the buffer. Implemented in Keos::CD3D9Buffer< T >, and Keos::COGLBuffer< Type >.

## Friends And Related Function Documentation

friend class CBuffer`[friend]`

| Definition at line 48 of file KeosBufferBase.h.

## Member Data Documentation

ulong Keos::IBufferBase::m_nCount`[protected]`

| Number of elements in the buffer. Definition at line 63 of file KeosBufferBase.h.

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

- KeosEngine/KeosBufferBase.h
- KeosEngine/KeosBufferBase.cpp