Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype Area = Area (ManagedPtr Area)
- newZeroArea :: MonadIO m => m Area
- areaCopy :: (HasCallStack, MonadIO m) => Area -> m Area
- areaFreeCb :: (HasCallStack, MonadIO m) => Ptr () -> Area -> m Int32
- areaGetData :: (HasCallStack, MonadIO m) => Area -> m (Ptr (), Word64, Int32, GType, Word64)
- areaNew :: (HasCallStack, MonadIO m) => CallbackFn -> m Area
- areaNewArray :: (HasCallStack, MonadIO m) => GType -> Word64 -> Int32 -> m Area
- areaNewArrayObject :: (HasCallStack, MonadIO m) => Int32 -> m Area
- areaUnref :: (HasCallStack, MonadIO m) => Area -> m ()
- clearAreaData :: MonadIO m => Area -> m ()
- getAreaData :: MonadIO m => Area -> m (Ptr ())
- setAreaData :: MonadIO m => Area -> Ptr () -> m ()
- getAreaLength :: MonadIO m => Area -> m Word64
- setAreaLength :: MonadIO m => Area -> Word64 -> m ()
- getAreaN :: MonadIO m => Area -> m Int32
- setAreaN :: MonadIO m => Area -> Int32 -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Area Source # | |
GBoxed Area Source # | |
Defined in GI.Vips.Structs.Area | |
ManagedPtrNewtype Area Source # | |
Defined in GI.Vips.Structs.Area toManagedPtr :: Area -> ManagedPtr Area | |
TypedObject Area Source # | |
Defined in GI.Vips.Structs.Area | |
HasParentTypes Area Source # | |
Defined in GI.Vips.Structs.Area | |
tag ~ 'AttrSet => Constructible Area tag Source # | |
IsGValue (Maybe Area) Source # | Convert |
Defined in GI.Vips.Structs.Area gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Area -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Area) | |
type ParentTypes Area Source # | |
Defined in GI.Vips.Structs.Area |
Methods
Click to display all available methods, including inherited ones
copy
areaCopy :: (HasCallStack, MonadIO m) => Area -> m Area Source #
No description available in the introspection data.
freeCb
areaFreeCb :: (HasCallStack, MonadIO m) => Ptr () -> Area -> m Int32 Source #
No description available in the introspection data.
getData
:: (HasCallStack, MonadIO m) | |
=> Area |
|
-> m (Ptr (), Word64, Int32, GType, Word64) | Returns: The pointer held by |
Return the data pointer plus optionally the length in bytes of an area,
the number of elements, the GType
of each element and the sizeof()
each
element.
new
:: (HasCallStack, MonadIO m) | |
=> CallbackFn |
|
-> m Area | Returns: the new |
A VipsArea wraps a chunk of memory. It adds reference counting and a free
function. It also keeps a count and a GType
, so the area can be an array.
This type is used for things like passing an array of double or an array of
Object
pointers to operations, and for reference-counted immutable
strings.
Inital count == 1, so _unref()
after attaching somewhere.
See also: areaUnref
.
newArray
:: (HasCallStack, MonadIO m) | |
=> GType |
|
-> Word64 |
|
-> Int32 |
|
-> m Area | Returns: the new |
An area which holds an array of elements of some GType
. To set values for
the elements, get the pointer and write.
See also: areaUnref
.
newArrayObject
:: (HasCallStack, MonadIO m) | |
=> Int32 |
|
-> m Area | Returns: the new |
An area which holds an array of GObject
s. See areaNewArray
. When
the area is freed, each GObject
will be unreffed.
Add an extra NULL element at the end, handy for eg.
vips_image_pipeline_array()
etc.
See also: areaUnref
.
unref
areaUnref :: (HasCallStack, MonadIO m) => Area -> m () Source #
No description available in the introspection data.
Properties
data
No description available in the introspection data.
clearAreaData :: MonadIO m => Area -> m () Source #
Set the value of the “data
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#data
getAreaData :: MonadIO m => Area -> m (Ptr ()) Source #
Get the value of the “data
” field.
When overloading is enabled, this is equivalent to
get
area #data
setAreaData :: MonadIO m => Area -> Ptr () -> m () Source #
Set the value of the “data
” field.
When overloading is enabled, this is equivalent to
set
area [ #data:=
value ]
length
No description available in the introspection data.
getAreaLength :: MonadIO m => Area -> m Word64 Source #
Get the value of the “length
” field.
When overloading is enabled, this is equivalent to
get
area #length
setAreaLength :: MonadIO m => Area -> Word64 -> m () Source #
Set the value of the “length
” field.
When overloading is enabled, this is equivalent to
set
area [ #length:=
value ]
n
No description available in the introspection data.