OGLplus (0.52.0) a C++ wrapper for OpenGL

oglplus::BufferRawMap Class Reference

Untyped mapping of the buffer to the client address space. More...

#include </home/chochlik/devel/oglplus/include/oglplus/buffer_map.hpp>

Inheritance diagram for oglplus::BufferRawMap:

Public Member Functions

 BufferRawMap (BufferTarget target, BufferSize byte_offset, BufferSize size_bytes, Bitfield< BufferMapAccess > access)
 Maps a range of the buffer. More...
 
 BufferRawMap (BufferTarget target, Bitfield< BufferMapAccess > access)
 Maps the whole buffer. More...
 
 BufferRawMap (BufferRawMap &&temp)
 Move construction is enabled.
 
 ~BufferRawMap (void)
 Unmaps the buffer from client address space (if mapped)
 
void Unmap (void)
 Unmaps the buffer from client address space. More...
 
bool Mapped (void) const
 Returns true if the buffer is mapped.
 
GLsizeiptr Size (void) const
 Returns the size (in bytes) of the mapped buffer.
 
const GLvoid * RawData (void) const
 Returns a const pointer to the mapped data. More...
 
GLvoid * RawData (void)
 Returns a pointer to the mapped data. More...
 
void FlushRange (BufferSize offset, BufferSize length)
 Indicate modifications to a mapped range. More...
 

Detailed Description

Untyped mapping of the buffer to the client address space.

Constructor & Destructor Documentation

oglplus::BufferRawMap::BufferRawMap ( BufferTarget  target,
BufferSize  byte_offset,
BufferSize  size_bytes,
Bitfield< BufferMapAccess access 
)

Maps a range of the buffer.

Parameters
targetuse the buffer bound to the specified target
byte_offsetmap offset in machine bytes
size_bytesmap size in machine bytes
accessthe access specifier for the buffer mapping
Related OpenGL symbols:
glMapBufferRange
Exceptions
Error
oglplus::BufferRawMap::BufferRawMap ( BufferTarget  target,
Bitfield< BufferMapAccess access 
)

Maps the whole buffer.

Parameters
targetuse the buffer bound to the target specified
accessthe access specifier for the buffer mapping

This class is non-copyable.

Related OpenGL symbols:
glMapBuffer
Exceptions
Error

Member Function Documentation

void oglplus::BufferRawMap::FlushRange ( BufferSize  offset,
BufferSize  length 
)

Indicate modifications to a mapped range.

Related OpenGL symbols:
glFlushMappedBufferRange
Precondition
Mapped()
Exceptions
Error

References oglplus::BufferSize::Get().

Referenced by oglplus::BufferTypedMap< Type >::FlushElements().

const GLvoid* oglplus::BufferRawMap::RawData ( void  ) const

Returns a const pointer to the mapped data.

Precondition
Mapped()

References Mapped().

Referenced by oglplus::BufferTypedMap< Type >::Data().

GLvoid* oglplus::BufferRawMap::RawData ( void  )

Returns a pointer to the mapped data.

Precondition
Mapped()

References Mapped().

void oglplus::BufferRawMap::Unmap ( void  )

Unmaps the buffer from client address space.

Related OpenGL symbols:
glUnmapBuffer
Exceptions
Error

Referenced by ~BufferRawMap().


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

Copyright © 2010-2014 Matúš Chochlík, University of Žilina, Žilina, Slovakia.
<matus.chochlik -at- fri.uniza.sk>
<chochlik -at -gmail.com>
Documentation generated on Mon Sep 22 2014 by Doxygen (version 1.8.6).