OpenGL-2.3.0.0: A binding for the OpenGL graphics system Source code Contents Index

Graphics.Rendering.OpenGL.GL.BufferObjects Portability portable Stability stable Maintainer sven.panne@aedion.de

Contents Object Names Buffer Objects Binding Buffer Objects Handling Buffer Data Mapping Buffer Objects

Description

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

Synopsis

module Data.ObjectName newtype BufferObject = BufferObject GLuint data BufferTarget = ArrayBuffer | CopyReadBuffer | CopyWriteBuffer | ElementArrayBuffer | PixelPackBuffer | PixelUnpackBuffer 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

Object Names

module Data.ObjectName

Buffer Objects

newtype BufferObject Source

Constructors BufferObject GLuint Instances Eq BufferObject Ord BufferObject Show BufferObject ObjectName BufferObject

Binding Buffer Objects

data BufferTarget Source

Constructors ArrayBuffer CopyReadBuffer CopyWriteBuffer ElementArrayBuffer PixelPackBuffer PixelUnpackBuffer Instances Eq BufferTarget Ord BufferTarget Show BufferTarget

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 Ord BufferUsage Show BufferUsage

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

data TransferDirection Source

Constructors ReadFromBuffer WriteToBuffer Instances Eq TransferDirection Ord TransferDirection Show TransferDirection

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

Mapping Buffer Objects

data BufferAccess Source

Constructors ReadOnly WriteOnly ReadWrite Instances Eq BufferAccess Ord BufferAccess Show BufferAccess

data MappingFailure Source

Constructors MappingFailed UnmappingFailed Instances Eq MappingFailure Ord MappingFailure Show MappingFailure

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

Produced by Haddock version 2.4.2