Graphics.Luminance.Buffer

Buffer creation

createBuffer :: forall a m rw. (BufferRW rw, MonadIO m, MonadResource m) => BuildBuffer rw a -> m a

Create a new Buffer. Through the 'BuildBuild type, you can yield new regions and embed them in the type of your choice. The function returns that type.

Buffer access

class BufferRW rw

Buffers can have reads and writes. That typeclass makes implements all possible cases.

Minimal complete definition

bufferFlagsFromRW

Instances

BufferRW RW

BufferRW W

BufferRW R

Buffer regions

data Buffer rw a

A Buffer is a GPU typed memory area. It can be pictured as a GPU array.

Instances

Eq (Buffer rw a)

Show (Buffer rw a)

data BuildBuffer rw a

Convenient type to build Buffers.

Instances

Monad (BuildBuffer rw)

Functor (BuildBuffer rw)

Applicative (BuildBuffer rw)

newRegion :: forall rw a. Storable a => Word32 -> BuildBuffer rw (Buffer rw a)

Create a new Buffer by providing the number of wished elements.

Operations on buffer regions

readWhole :: (MonadIO m, Readable r, Storable a) => Buffer r a -> m [a]

Read a whole Buffer.

writeWhole :: (Foldable f, MonadIO m, Storable a, Writable w) => Buffer w a -> f a -> m ()

Write the whole Buffer. If values are missing, only the provided values will replace the existing ones. If there are more values than the size of the Buffer, they are ignored.

fill :: (MonadIO m, Storable a, Writable w) => Buffer w a -> a -> m ()

Fill a Buffer with a value.

(@?) :: (MonadIO m, Storable a, Readable r) => Buffer r a -> Word32 -> m (Maybe a)

Index getter. Bounds checking is performed and returns Nothing if out of bounds.

(@!) :: (MonadIO m, Storable a, Readable r) => Buffer r a -> Word32 -> m a

Index getter. Unsafe version of '(@?)'.

writeAt :: (MonadIO m, Storable a, Writable w) => Buffer w a -> Word32 -> a -> m ()

Index setter. Bounds checking is performed and nothing is done if out of bounds.

writeAt' :: (MonadIO m, Storable a, Writable w) => Buffer w a -> Word32 -> a -> m ()

Index setter. Unsafe version of writeAt.