Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gio.Structs.OutputVector

Contents

Exported types
Methods
Properties
- buffer
- size

Description

Structure used for scatter/gather data output. You generally pass in an array of GOutputVectors and the operation will use all the buffers as if they were one buffer.

Since: 2.22

Synopsis

newtype OutputVector = OutputVector (ManagedPtr OutputVector)
newZeroOutputVector :: MonadIO m => m OutputVector
type family ResolveOutputVectorMethod (t :: Symbol) o where ...
clearOutputVectorBuffer :: MonadIO m => OutputVector -> m ()
getOutputVectorBuffer :: MonadIO m => OutputVector -> m (Ptr ())
outputVector_buffer :: AttrLabelProxy "buffer"
setOutputVectorBuffer :: MonadIO m => OutputVector -> Ptr () -> m ()
getOutputVectorSize :: MonadIO m => OutputVector -> m CSize
outputVector_size :: AttrLabelProxy "size"
setOutputVectorSize :: MonadIO m => OutputVector -> CSize -> m ()

Exported types

newtype OutputVector Source #

Memory-managed wrapper type.

Constructors

OutputVector (ManagedPtr OutputVector)

Instances

Instances details

Eq OutputVector Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods (==) :: OutputVector -> OutputVector -> Bool # (/=) :: OutputVector -> OutputVector -> Bool #
BoxedPtr OutputVector Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods boxedPtrCopy :: OutputVector -> IO OutputVector # boxedPtrFree :: OutputVector -> IO () #
CallocPtr OutputVector Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods boxedPtrCalloc :: IO (Ptr OutputVector) #
ManagedPtrNewtype OutputVector Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods toManagedPtr :: OutputVector -> ManagedPtr OutputVector #
tag ~ 'AttrSet => Constructible OutputVector tag Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods new :: MonadIO m => (ManagedPtr OutputVector -> OutputVector) -> [AttrOp OutputVector tag] -> m OutputVector #
HasAttributeList OutputVector Source #
Instance details Defined in GI.Gio.Structs.OutputVector
(info ~ ResolveOutputVectorMethod t OutputVector, OverloadedMethod info OutputVector p, HasField t OutputVector p) => HasField (t :: Symbol) OutputVector (p :: Type) Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods getField :: OutputVector -> p #
(info ~ ResolveOutputVectorMethod t OutputVector, OverloadedMethodInfo info OutputVector) => IsLabel t (MethodProxy info OutputVector) Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods fromLabel :: MethodProxy info OutputVector #
(info ~ ResolveOutputVectorMethod t OutputVector, OverloadedMethod info OutputVector p) => IsLabel t (OutputVector -> p) Source #
Instance details Defined in GI.Gio.Structs.OutputVector Methods fromLabel :: OutputVector -> p #
type AttributeList OutputVector Source #
Instance details Defined in GI.Gio.Structs.OutputVector type AttributeList OutputVector

newZeroOutputVector :: MonadIO m => m OutputVector Source #

Construct a OutputVector struct initialized to zero.

Methods

type family ResolveOutputVectorMethod (t :: Symbol) o where ... Source #

Equations

ResolveOutputVectorMethod l o = MethodResolutionFailed l o :: Type

Properties

buffer

Pointer to a buffer of data to read.

clearOutputVectorBuffer :: MonadIO m => OutputVector -> m () Source #

Set the value of the “buffer” field to Nothing. When overloading is enabled, this is equivalent to

clear #buffer

getOutputVectorBuffer :: MonadIO m => OutputVector -> m (Ptr ()) Source #

Get the value of the “buffer” field. When overloading is enabled, this is equivalent to

get outputVector #buffer

outputVector_buffer :: AttrLabelProxy "buffer" Source #

setOutputVectorBuffer :: MonadIO m => OutputVector -> Ptr () -> m () Source #

Set the value of the “buffer” field. When overloading is enabled, this is equivalent to

set outputVector [ #buffer := value ]

size

the size of buffer.

getOutputVectorSize :: MonadIO m => OutputVector -> m CSize Source #

Get the value of the “size” field. When overloading is enabled, this is equivalent to

get outputVector #size

outputVector_size :: AttrLabelProxy "size" Source #

setOutputVectorSize :: MonadIO m => OutputVector -> CSize -> m () Source #

Set the value of the “size” field. When overloading is enabled, this is equivalent to

set outputVector [ #size := value ]