GI.Vips.Structs.Area

No description available in the introspection data.

Exported types

newtype Area

Memory-managed wrapper type.

Constructors

Area (ManagedPtr Area)

Instances

Eq Area

Defined in GI.Vips.Structs.Area

Methods

(==) :: Area -> Area -> Bool

(/=) :: Area -> Area -> Bool

GBoxed Area

Defined in GI.Vips.Structs.Area

ManagedPtrNewtype Area

Defined in GI.Vips.Structs.Area

Methods

toManagedPtr :: Area -> ManagedPtr Area

TypedObject Area

Defined in GI.Vips.Structs.Area

Methods

glibType :: IO GType

HasParentTypes Area

Defined in GI.Vips.Structs.Area

tag ~ 'AttrSet => Constructible Area tag

Defined in GI.Vips.Structs.Area

Methods

new :: MonadIO m => (ManagedPtr Area -> Area) -> [AttrOp Area tag] -> m Area

IsGValue (Maybe Area)

Convert Area to and from GValue. See toGValue and fromGValue.

Defined in GI.Vips.Structs.Area

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Area -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Area)

type ParentTypes Area

Defined in GI.Vips.Structs.Area

type ParentTypes Area = '[] :: [Type]

newZeroArea :: MonadIO m => m Area

Construct a Area struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

areaGetData, copy, unref.

Getters

None.

Setters

None.

areaGetData

areaAreaGetData

Arguments

:: (HasCallStack, MonadIO m)

=> Area

area: Area to fetch from

-> Word64

length: optionally return length in bytes here

-> Int32

n: optionally return number of elements here

-> GType

type: optionally return element type here

-> Word64

sizeofType: optionally return sizeof() element type here

-> m (Ptr ())

Returns: The pointer held by area.

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.

copy

areaCopy :: (HasCallStack, MonadIO m) => Area -> m Area

No description available in the introspection data.

new

areaNew

Arguments

:: (HasCallStack, MonadIO m)

=> CallbackFn

freeFn: data will be freed with this function

-> m Area

Returns: the new Area.

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

areaNewArray

Arguments

:: (HasCallStack, MonadIO m)

=> GType

type: GType of elements to store

-> Word64

sizeofType: sizeof() an element in the array

-> Int32

n: number of elements in the array

-> m Area

Returns: the new Area.

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

areaNewArrayObject

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

n: number of elements in the array

-> m Area

Returns: the new Area.

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 ()

No description available in the introspection data.

Properties

data

No description available in the introspection data.

clearAreaData :: MonadIO m => Area -> m ()

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 ())

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

get area #data

setAreaData :: MonadIO m => Area -> Ptr () -> m ()

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

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

get area #length

setAreaLength :: MonadIO m => Area -> Word64 -> m ()

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.

getAreaN :: MonadIO m => Area -> m Int32

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

get area #n

setAreaN :: MonadIO m => Area -> Int32 -> m ()

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

set area [ #n := value ]