blob: 52318c1de5f9bd7505f92364bfd7216dada8e4b4 [file] [log] [blame]
/*
* Copyright 2011 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef GrGeometryBuffer_DEFINED
#define GrGeometryBuffer_DEFINED
#include "GrResource.h"
class GrGpu;
/**
* Parent class for vertex and index buffers
*/
class GrGeometryBuffer : public GrResource {
public:
SK_DECLARE_INST_COUNT(GrGeometryBuffer);
/**
*Retrieves whether the buffer was created with the dynamic flag
*
* @return true if the buffer was created with the dynamic flag
*/
bool dynamic() const { return fDynamic; }
/**
* Locks the buffer to be written by the CPU.
*
* The previous content of the buffer is invalidated. It is an error
* to draw from the buffer while it is locked. It is an error to call lock
* on an already locked buffer.
*
* @return a pointer to the data or NULL if the lock fails.
*/
virtual void* lock() = 0;
/**
* Returns the same ptr that lock() returned at time of lock or NULL if the
* is not locked.
*
* @return ptr to locked buffer data or undefined if buffer is not locked.
*/
virtual void* lockPtr() const = 0;
/**
* Unlocks the buffer.
*
* The pointer returned by the previous lock call will no longer be valid.
*/
virtual void unlock() = 0;
/**
Queries whether the buffer has been locked.
@return true if the buffer is locked, false otherwise.
*/
virtual bool isLocked() const = 0;
/**
* Updates the buffer data.
*
* The size of the buffer will be preserved. The src data will be
* placed at the begining of the buffer and any remaining contents will
* be undefined.
*
* @return returns true if the update succeeds, false otherwise.
*/
virtual bool updateData(const void* src, size_t srcSizeInBytes) = 0;
// GrResource overrides
virtual size_t sizeInBytes() const { return fSizeInBytes; }
protected:
GrGeometryBuffer(GrGpu* gpu, bool isWrapped, size_t sizeInBytes, bool dynamic)
: INHERITED(gpu, isWrapped)
, fSizeInBytes(sizeInBytes)
, fDynamic(dynamic) {}
private:
size_t fSizeInBytes;
bool fDynamic;
typedef GrResource INHERITED;
};
#endif