Copyright	(c) Sven Panne 2002-2016
License	BSD3
Maintainer	Sven Panne <svenpanne@gmail.com>
Stability	stable
Portability	portable
Safe Haskell	None
Language	Haskell2010

Graphics.Rendering.OpenGL.GL.BufferObjects

Contents

Buffer Objects
Binding Buffer Objects
Handling Buffer Data
Mapping Buffer Objects
Indexed Buffer manipulation

Description

This module corresponds to section 2.9 (Buffer Objects) of the OpenGL 2.1 specs.

Synopsis

Buffer Objects

data BufferObject Source #

Instances

Eq BufferObject Source #
Methods (==) :: BufferObject -> BufferObject -> Bool # (/=) :: BufferObject -> BufferObject -> Bool #
Ord BufferObject Source #
Methods compare :: BufferObject -> BufferObject -> Ordering # (<) :: BufferObject -> BufferObject -> Bool # (<=) :: BufferObject -> BufferObject -> Bool # (>) :: BufferObject -> BufferObject -> Bool # (>=) :: BufferObject -> BufferObject -> Bool # max :: BufferObject -> BufferObject -> BufferObject # min :: BufferObject -> BufferObject -> BufferObject #
Show BufferObject Source #
Methods showsPrec :: Int -> BufferObject -> ShowS # show :: BufferObject -> String # showList :: [BufferObject] -> ShowS #
ObjectName BufferObject Source #
Methods isObjectName :: MonadIO m => BufferObject -> m Bool # deleteObjectName :: MonadIO m => BufferObject -> m () # deleteObjectNames :: MonadIO m => [BufferObject] -> m () #
GeneratableObjectName BufferObject Source #
Methods genObjectName :: MonadIO m => m BufferObject # genObjectNames :: MonadIO m => Int -> m [BufferObject] #
CanBeLabeled BufferObject Source #
Methods objectLabel :: BufferObject -> StateVar (Maybe String) Source #

Binding Buffer Objects

data BufferTarget Source #

Constructors

ArrayBuffer
AtomicCounterBuffer
CopyReadBuffer
CopyWriteBuffer
DispatchIndirectBuffer
DrawIndirectBuffer
ElementArrayBuffer
PixelPackBuffer
PixelUnpackBuffer
QueryBuffer
ShaderStorageBuffer
TextureBuffer
TransformFeedbackBuffer
UniformBuffer

Instances

Eq BufferTarget Source #
Methods (==) :: BufferTarget -> BufferTarget -> Bool # (/=) :: BufferTarget -> BufferTarget -> Bool #
Ord BufferTarget Source #
Methods compare :: BufferTarget -> BufferTarget -> Ordering # (<) :: BufferTarget -> BufferTarget -> Bool # (<=) :: BufferTarget -> BufferTarget -> Bool # (>) :: BufferTarget -> BufferTarget -> Bool # (>=) :: BufferTarget -> BufferTarget -> Bool # max :: BufferTarget -> BufferTarget -> BufferTarget # min :: BufferTarget -> BufferTarget -> BufferTarget #
Show BufferTarget Source #
Methods showsPrec :: Int -> BufferTarget -> ShowS # show :: BufferTarget -> String # showList :: [BufferTarget] -> ShowS #

bindBuffer :: BufferTarget -> StateVar (Maybe BufferObject) Source #

arrayBufferBinding :: ClientArrayType -> GettableStateVar (Maybe BufferObject) Source #

vertexAttribArrayBufferBinding :: AttribLocation -> GettableStateVar (Maybe BufferObject) Source #

Handling Buffer Data

data BufferUsage Source #

Constructors

StreamDraw
StreamRead
StreamCopy
StaticDraw
StaticRead
StaticCopy
DynamicDraw
DynamicRead
DynamicCopy

Instances

Eq BufferUsage Source #
Methods (==) :: BufferUsage -> BufferUsage -> Bool # (/=) :: BufferUsage -> BufferUsage -> Bool #
Ord BufferUsage Source #
Methods compare :: BufferUsage -> BufferUsage -> Ordering # (<) :: BufferUsage -> BufferUsage -> Bool # (<=) :: BufferUsage -> BufferUsage -> Bool # (>) :: BufferUsage -> BufferUsage -> Bool # (>=) :: BufferUsage -> BufferUsage -> Bool # max :: BufferUsage -> BufferUsage -> BufferUsage # min :: BufferUsage -> BufferUsage -> BufferUsage #
Show BufferUsage Source #
Methods showsPrec :: Int -> BufferUsage -> ShowS # show :: BufferUsage -> String # showList :: [BufferUsage] -> ShowS #

bufferData :: BufferTarget -> StateVar (GLsizeiptr, Ptr a, BufferUsage) Source #

data TransferDirection Source #

Constructors

ReadFromBuffer
WriteToBuffer

Instances

Eq TransferDirection Source #
Methods (==) :: TransferDirection -> TransferDirection -> Bool # (/=) :: TransferDirection -> TransferDirection -> Bool #
Ord TransferDirection Source #
Methods compare :: TransferDirection -> TransferDirection -> Ordering # (<) :: TransferDirection -> TransferDirection -> Bool # (<=) :: TransferDirection -> TransferDirection -> Bool # (>) :: TransferDirection -> TransferDirection -> Bool # (>=) :: TransferDirection -> TransferDirection -> Bool # max :: TransferDirection -> TransferDirection -> TransferDirection # min :: TransferDirection -> TransferDirection -> TransferDirection #
Show TransferDirection Source #
Methods showsPrec :: Int -> TransferDirection -> ShowS # show :: TransferDirection -> String # showList :: [TransferDirection] -> ShowS #

bufferSubData :: BufferTarget -> TransferDirection -> GLintptr -> GLsizeiptr -> Ptr a -> IO () Source #

Mapping Buffer Objects

data BufferAccess Source #

Constructors

ReadOnly
WriteOnly
ReadWrite

Instances

Eq BufferAccess Source #
Methods (==) :: BufferAccess -> BufferAccess -> Bool # (/=) :: BufferAccess -> BufferAccess -> Bool #
Ord BufferAccess Source #
Methods compare :: BufferAccess -> BufferAccess -> Ordering # (<) :: BufferAccess -> BufferAccess -> Bool # (<=) :: BufferAccess -> BufferAccess -> Bool # (>) :: BufferAccess -> BufferAccess -> Bool # (>=) :: BufferAccess -> BufferAccess -> Bool # max :: BufferAccess -> BufferAccess -> BufferAccess # min :: BufferAccess -> BufferAccess -> BufferAccess #
Show BufferAccess Source #
Methods showsPrec :: Int -> BufferAccess -> ShowS # show :: BufferAccess -> String # showList :: [BufferAccess] -> ShowS #

data MappingFailure Source #

Constructors

MappingFailed
UnmappingFailed

Instances

Eq MappingFailure Source #
Methods (==) :: MappingFailure -> MappingFailure -> Bool # (/=) :: MappingFailure -> MappingFailure -> Bool #
Ord MappingFailure Source #
Methods compare :: MappingFailure -> MappingFailure -> Ordering # (<) :: MappingFailure -> MappingFailure -> Bool # (<=) :: MappingFailure -> MappingFailure -> Bool # (>) :: MappingFailure -> MappingFailure -> Bool # (>=) :: MappingFailure -> MappingFailure -> Bool # max :: MappingFailure -> MappingFailure -> MappingFailure # min :: MappingFailure -> MappingFailure -> MappingFailure #
Show MappingFailure Source #
Methods showsPrec :: Int -> MappingFailure -> ShowS # show :: MappingFailure -> String # showList :: [MappingFailure] -> ShowS #

withMappedBuffer :: BufferTarget -> BufferAccess -> (Ptr a -> IO b) -> (MappingFailure -> IO b) -> IO b Source #

Convenience function for an exception-safe combination of mapBuffer and unmapBuffer.

mapBuffer :: BufferTarget -> BufferAccess -> IO (Maybe (Ptr a)) Source #

unmapBuffer :: BufferTarget -> IO Bool Source #

bufferAccess :: BufferTarget -> GettableStateVar BufferAccess Source #

bufferMapped :: BufferTarget -> GettableStateVar Bool Source #

data MapBufferUsage Source #

Constructors

Read
Write
InvalidateRange
InvalidateBuffer
FlushExplicit
Unsychronized

Instances

Eq MapBufferUsage Source #
Methods (==) :: MapBufferUsage -> MapBufferUsage -> Bool # (/=) :: MapBufferUsage -> MapBufferUsage -> Bool #
Ord MapBufferUsage Source #
Methods compare :: MapBufferUsage -> MapBufferUsage -> Ordering # (<) :: MapBufferUsage -> MapBufferUsage -> Bool # (<=) :: MapBufferUsage -> MapBufferUsage -> Bool # (>) :: MapBufferUsage -> MapBufferUsage -> Bool # (>=) :: MapBufferUsage -> MapBufferUsage -> Bool # max :: MapBufferUsage -> MapBufferUsage -> MapBufferUsage # min :: MapBufferUsage -> MapBufferUsage -> MapBufferUsage #
Show MapBufferUsage Source #
Methods showsPrec :: Int -> MapBufferUsage -> ShowS # show :: MapBufferUsage -> String # showList :: [MapBufferUsage] -> ShowS #

type Offset = GLintptr Source #

type Length = GLsizeiptr Source #

mapBufferRange :: BufferTarget -> Offset -> Length -> [MapBufferUsage] -> IO (Maybe (Ptr a)) Source #

flushMappedBufferRange :: BufferTarget -> Offset -> Length -> IO () Source #

Indexed Buffer manipulation

type BufferIndex = GLuint Source #

type RangeStartIndex = GLintptr Source #

type RangeSize = GLsizeiptr Source #

type BufferRange = (BufferObject, RangeStartIndex, RangeSize) Source #

data IndexedBufferTarget Source #

Constructors

IndexedAtomicCounterBuffer
IndexedShaderStorageBuffer
IndexedTransformFeedbackBuffer
IndexedUniformBuffer

Instances

Eq IndexedBufferTarget Source #
Methods (==) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool # (/=) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool #
Ord IndexedBufferTarget Source #
Methods compare :: IndexedBufferTarget -> IndexedBufferTarget -> Ordering # (<) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool # (<=) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool # (>) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool # (>=) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool # max :: IndexedBufferTarget -> IndexedBufferTarget -> IndexedBufferTarget # min :: IndexedBufferTarget -> IndexedBufferTarget -> IndexedBufferTarget #
Show IndexedBufferTarget Source #
Methods showsPrec :: Int -> IndexedBufferTarget -> ShowS # show :: IndexedBufferTarget -> String # showList :: [IndexedBufferTarget] -> ShowS #

bindBufferBase :: IndexedBufferTarget -> BufferIndex -> StateVar (Maybe BufferObject) Source #

bindBufferRange :: IndexedBufferTarget -> BufferIndex -> StateVar (Maybe BufferRange) Source #

indexedBufferStart :: IndexedBufferTarget -> BufferIndex -> GettableStateVar RangeStartIndex Source #

indexedBufferSize :: IndexedBufferTarget -> BufferIndex -> GettableStateVar RangeSize Source #