VVISF & VVGL
VVGL::GLBuffer::Descriptor Struct Reference

The Descriptor struct describes the hardware attributes of the GLBuffer. More...

#include <GLBuffer.hpp>

Public Member Functions

uint32_t bytesPerRowForWidth (const uint32_t &w) const
 Returns the amount of memory in bytes that a single row of the provided width requires with the receiver's properties.
 
uint32_t backingLengthForSize (const Size &s) const
 Returns the amount of memory in bytes required to accommodate a buffer of the passed size with the receiver's properties.
 

Public Attributes

Type type = Type_Tex
 What type of buffer this is (texture, renderbuffer, etc.)
 
Target target = Target_2D
 What kind of texture this is (only used if this buffer is Type_Tex)
 
InternalFormat internalFormat = IF_RGBA
 The internal format of the GL texture (only used if this buffer is Type_Tex)
 
PixelFormat pixelFormat = PF_RGBA
 The internal pixel format of the buffer (only used if this buffer is Type_Tex or Type_RB.
 
PixelType pixelType = PT_UByte
 The internal pixel type of the buffer (only used if this buffer is Type_Tex).
 
Backing cpuBackingType = Backing_None
 The nature of the backing of the CPU resource for this GLBuffer.
 
Backing gpuBackingType = Backing_None
 The nature of the backing of the GPU resource for this GLBuffer.
 
bool texRangeFlag = false
 Only used by Mac SDK, indicates platform-specific optimization.
 
bool texClientStorageFlag = false
 Only used by Mac SDK, indicates platform-specific optimization.
 
uint32_t localSurfaceID = 0
 Only used by Mac SDK, indicates platform-specific optimization.
 

Detailed Description

The Descriptor struct describes the hardware attributes of the GLBuffer.

These are usually properties that cannot be changed, and are in their own struct for organizational purposes (buffers in the pool are checked for compatibility using equality of instances of this struct)


The documentation for this struct was generated from the following file: