Copyright	(c) Sven Panne 2002-2018
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

data BufferObject
data BufferTarget
- = ArrayBuffer
- | AtomicCounterBuffer
- | CopyReadBuffer
- | CopyWriteBuffer
- | DispatchIndirectBuffer
- | DrawIndirectBuffer
- | ElementArrayBuffer
- | PixelPackBuffer
- | PixelUnpackBuffer
- | QueryBuffer
- | ShaderStorageBuffer
- | TextureBuffer
- | TransformFeedbackBuffer
- | UniformBuffer
bindBuffer :: BufferTarget -> StateVar (Maybe BufferObject)
arrayBufferBinding :: ClientArrayType -> GettableStateVar (Maybe BufferObject)
vertexAttribArrayBufferBinding :: AttribLocation -> GettableStateVar (Maybe BufferObject)
data BufferUsage
- = StreamDraw
- | StreamRead
- | StreamCopy
- | StaticDraw
- | StaticRead
- | StaticCopy
- | DynamicDraw
- | DynamicRead
- | DynamicCopy
bufferData :: BufferTarget -> StateVar (GLsizeiptr, Ptr a, BufferUsage)
data TransferDirection
- = ReadFromBuffer
- | WriteToBuffer
bufferSubData :: BufferTarget -> TransferDirection -> GLintptr -> GLsizeiptr -> Ptr a -> IO ()
data BufferAccess
- = ReadOnly
- | WriteOnly
- | ReadWrite
data MappingFailure
- = MappingFailed
- | UnmappingFailed
withMappedBuffer :: BufferTarget -> BufferAccess -> (Ptr a -> IO b) -> (MappingFailure -> IO b) -> IO b
mapBuffer :: BufferTarget -> BufferAccess -> IO (Maybe (Ptr a))
unmapBuffer :: BufferTarget -> IO Bool
bufferAccess :: BufferTarget -> GettableStateVar BufferAccess
bufferMapped :: BufferTarget -> GettableStateVar Bool
data MapBufferUsage
- = Read
- | Write
- | InvalidateRange
- | InvalidateBuffer
- | FlushExplicit
- | Unsychronized
type Offset = GLintptr
type Length = GLsizeiptr
mapBufferRange :: BufferTarget -> Offset -> Length -> [MapBufferUsage] -> IO (Maybe (Ptr a))
flushMappedBufferRange :: BufferTarget -> Offset -> Length -> IO ()
type BufferIndex = GLuint
type RangeStartIndex = GLintptr
type RangeSize = GLsizeiptr
type BufferRange = (BufferObject, RangeStartIndex, RangeSize)
data IndexedBufferTarget
- = IndexedAtomicCounterBuffer
- | IndexedShaderStorageBuffer
- | IndexedTransformFeedbackBuffer
- | IndexedUniformBuffer
bindBufferBase :: IndexedBufferTarget -> BufferIndex -> StateVar (Maybe BufferObject)
bindBufferRange :: IndexedBufferTarget -> BufferIndex -> StateVar (Maybe BufferRange)
indexedBufferStart :: IndexedBufferTarget -> BufferIndex -> GettableStateVar RangeStartIndex
indexedBufferSize :: IndexedBufferTarget -> BufferIndex -> GettableStateVar RangeSize

Buffer Objects

data BufferObject #

Instances

Eq BufferObject #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: BufferObject -> BufferObject -> Bool # (/=) :: BufferObject -> BufferObject -> Bool #
Ord BufferObject #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> BufferObject -> ShowS # show :: BufferObject -> String # showList :: [BufferObject] -> ShowS #
ObjectName BufferObject #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods isObjectName :: MonadIO m => BufferObject -> m Bool # deleteObjectName :: MonadIO m => BufferObject -> m () # deleteObjectNames :: MonadIO m => [BufferObject] -> m () #
GeneratableObjectName BufferObject #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods genObjectName :: MonadIO m => m BufferObject # genObjectNames :: MonadIO m => Int -> m [BufferObject] #
CanBeLabeled BufferObject #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods objectLabel :: BufferObject -> StateVar (Maybe String) #

Binding Buffer Objects

data BufferTarget #

Constructors

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

Instances

Eq BufferTarget #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: BufferTarget -> BufferTarget -> Bool # (/=) :: BufferTarget -> BufferTarget -> Bool #
Ord BufferTarget #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> BufferTarget -> ShowS # show :: BufferTarget -> String # showList :: [BufferTarget] -> ShowS #

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

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

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

Handling Buffer Data

data BufferUsage #

Constructors

StreamDraw
StreamRead
StreamCopy
StaticDraw
StaticRead
StaticCopy
DynamicDraw
DynamicRead
DynamicCopy

Instances

Eq BufferUsage #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: BufferUsage -> BufferUsage -> Bool # (/=) :: BufferUsage -> BufferUsage -> Bool #
Ord BufferUsage #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> BufferUsage -> ShowS # show :: BufferUsage -> String # showList :: [BufferUsage] -> ShowS #

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

data TransferDirection #

Constructors

ReadFromBuffer
WriteToBuffer

Instances

Eq TransferDirection #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: TransferDirection -> TransferDirection -> Bool # (/=) :: TransferDirection -> TransferDirection -> Bool #
Ord TransferDirection #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> TransferDirection -> ShowS # show :: TransferDirection -> String # showList :: [TransferDirection] -> ShowS #

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

Mapping Buffer Objects

data BufferAccess #

Constructors

ReadOnly
WriteOnly
ReadWrite

Instances

Eq BufferAccess #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: BufferAccess -> BufferAccess -> Bool # (/=) :: BufferAccess -> BufferAccess -> Bool #
Ord BufferAccess #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> BufferAccess -> ShowS # show :: BufferAccess -> String # showList :: [BufferAccess] -> ShowS #

data MappingFailure #

Constructors

MappingFailed
UnmappingFailed

Instances

Eq MappingFailure #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: MappingFailure -> MappingFailure -> Bool # (/=) :: MappingFailure -> MappingFailure -> Bool #
Ord MappingFailure #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> MappingFailure -> ShowS # show :: MappingFailure -> String # showList :: [MappingFailure] -> ShowS #

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

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

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

unmapBuffer :: BufferTarget -> IO Bool #

bufferAccess :: BufferTarget -> GettableStateVar BufferAccess #

bufferMapped :: BufferTarget -> GettableStateVar Bool #

data MapBufferUsage #

Constructors

Read
Write
InvalidateRange
InvalidateBuffer
FlushExplicit
Unsychronized

Instances

Eq MapBufferUsage #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: MapBufferUsage -> MapBufferUsage -> Bool # (/=) :: MapBufferUsage -> MapBufferUsage -> Bool #
Ord MapBufferUsage #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> MapBufferUsage -> ShowS # show :: MapBufferUsage -> String # showList :: [MapBufferUsage] -> ShowS #

type Offset = GLintptr #

type Length = GLsizeiptr #

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

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

Indexed Buffer manipulation

type BufferIndex = GLuint #

type RangeStartIndex = GLintptr #

type RangeSize = GLsizeiptr #

type BufferRange = (BufferObject, RangeStartIndex, RangeSize) #

data IndexedBufferTarget #

Constructors

IndexedAtomicCounterBuffer
IndexedShaderStorageBuffer
IndexedTransformFeedbackBuffer
IndexedUniformBuffer

Instances

Eq IndexedBufferTarget #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods (==) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool # (/=) :: IndexedBufferTarget -> IndexedBufferTarget -> Bool #
Ord IndexedBufferTarget #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects 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 #
Instance details Defined in Graphics.Rendering.OpenGL.GL.BufferObjects Methods showsPrec :: Int -> IndexedBufferTarget -> ShowS # show :: IndexedBufferTarget -> String # showList :: [IndexedBufferTarget] -> ShowS #

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

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

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

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