GI.Graphene.Structs.Size

A size.

Since: 1.0

Exported types

newtype Size

Memory-managed wrapper type.

Constructors

Size (ManagedPtr Size)

Instances

Eq Size

Defined in GI.Graphene.Structs.Size

Methods

(==) :: Size -> Size -> Bool

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

GBoxed Size

Defined in GI.Graphene.Structs.Size

ManagedPtrNewtype Size

Defined in GI.Graphene.Structs.Size

Methods

toManagedPtr :: Size -> ManagedPtr Size

TypedObject Size

Defined in GI.Graphene.Structs.Size

Methods

glibType :: IO GType

HasParentTypes Size

Defined in GI.Graphene.Structs.Size

tag ~ 'AttrSet => Constructible Size tag

Defined in GI.Graphene.Structs.Size

Methods

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

IsGValue (Maybe Size)

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

Defined in GI.Graphene.Structs.Size

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Size

Defined in GI.Graphene.Structs.Size

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

newZeroSize :: MonadIO m => m Size

Construct a Size struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

equal, free, init, initFromSize, interpolate, scale.

Getters

None.

Setters

None.

alloc

sizeAlloc

Arguments

:: (HasCallStack, MonadIO m)

=> m Size

Returns: the newly allocated Size

Allocates a new Size.

The contents of the returned value are undefined.

Since: 1.0

equal

sizeEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Size

a: a Size

-> Size

b: a Size

-> m Bool

Returns: true if the sizes are equal

Checks whether the two give Size are equal.

Since: 1.0

free

sizeFree

Arguments

:: (HasCallStack, MonadIO m)

=> Size

s: a Size

-> m ()

Frees the resources allocated by sizeAlloc.

Since: 1.0

init

sizeInit

Arguments

:: (HasCallStack, MonadIO m)

=> Size

s: a Size

-> Float

width: the width

-> Float

height: the height

-> m Size

Returns: the initialized Size

Initializes a Size using the given width and height.

Since: 1.0

initFromSize

sizeInitFromSize

Arguments

:: (HasCallStack, MonadIO m)

=> Size

s: a Size

-> Size

src: a Size

-> m Size

Returns: the initialized Size

Initializes a Size using the width and height of the given src.

Since: 1.0

interpolate

sizeInterpolate

Arguments

:: (HasCallStack, MonadIO m)

=> Size

a: a Size

-> Size

b: a Size

-> Double

factor: the linear interpolation factor

-> m Size

Linearly interpolates the two given Size using the given interpolation factor.

Since: 1.0

scale

sizeScale

Arguments

:: (HasCallStack, MonadIO m)

=> Size

s: a Size

-> Float

factor: the scaling factor

-> m Size

Scales the components of a Size using the given factor.

Since: 1.0

zero

sizeZero

Arguments

:: (HasCallStack, MonadIO m)

=> m Size

Returns: a constant size

A constant pointer to a zero Size, useful for equality checks and interpolations.

Since: 1.0

Properties

height

the height

getSizeHeight :: MonadIO m => Size -> m Float

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

get size #height

setSizeHeight :: MonadIO m => Size -> Float -> m ()

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

set size [ #height := value ]

width

the width

getSizeWidth :: MonadIO m => Size -> m Float

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

get size #width

setSizeWidth :: MonadIO m => Size -> Float -> m ()

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

set size [ #width := value ]