GI.Clutter.Structs.Vertex

A point in 3D space, expressed in pixels

Since: 0.4

Exported types

newtype Vertex

Memory-managed wrapper type.

Constructors

Vertex (ManagedPtr Vertex)

Instances

Eq Vertex

Defined in GI.Clutter.Structs.Vertex

Methods

(==) :: Vertex -> Vertex -> Bool

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

GBoxed Vertex

Defined in GI.Clutter.Structs.Vertex

ManagedPtrNewtype Vertex

Defined in GI.Clutter.Structs.Vertex

Methods

toManagedPtr :: Vertex -> ManagedPtr Vertex

TypedObject Vertex

Defined in GI.Clutter.Structs.Vertex

Methods

glibType :: IO GType

HasParentTypes Vertex

Defined in GI.Clutter.Structs.Vertex

tag ~ 'AttrSet => Constructible Vertex tag

Defined in GI.Clutter.Structs.Vertex

Methods

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

IsGValue (Maybe Vertex)

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

Defined in GI.Clutter.Structs.Vertex

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Vertex

Defined in GI.Clutter.Structs.Vertex

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

newZeroVertex :: MonadIO m => m Vertex

Construct a Vertex struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

copy, equal, free, init.

Getters

None.

Setters

None.

alloc

vertexAlloc

Arguments

:: (HasCallStack, MonadIO m)

=> m Vertex

Returns: the newly allocated Vertex. Use vertexFree to free its resources

Allocates a new, empty Vertex.

Since: 1.12

copy

vertexCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Vertex

vertex: a Vertex

-> m Vertex

Returns: a newly allocated copy of Vertex. Use vertexFree to free the allocated resources

Copies vertex

Since: 1.0

equal

vertexEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Vertex

vertexA: a Vertex

-> Vertex

vertexB: a Vertex

-> m Bool

Returns: True if the passed Vertex are equal

Compares vertexA and vertexB for equality

Since: 1.0

free

vertexFree

Arguments

:: (HasCallStack, MonadIO m)

=> Vertex

vertex: a Vertex

-> m ()

Frees a Vertex allocated using vertexAlloc or vertexCopy.

Since: 1.0

init

vertexInit

Arguments

:: (HasCallStack, MonadIO m)

=> Vertex

vertex: a Vertex

-> Float

x: X coordinate

-> Float

y: Y coordinate

-> Float

z: Z coordinate

-> m Vertex

Returns: the initialized Vertex

Initializes vertex with the given coordinates.

Since: 1.10

new

vertexNew

Arguments

:: (HasCallStack, MonadIO m)

=> Float

x: X coordinate

-> Float

y: Y coordinate

-> Float

z: Z coordinate

-> m Vertex

Returns: the newly allocated Vertex. Use vertexFree to free the resources

Creates a new Vertex for the point in 3D space identified by the 3 coordinates x, y, z.

This function is the logical equivalent of:

 clutter_vertex_init (clutter_vertex_alloc (), x, y, z);

Since: 1.0

Properties

x

X coordinate of the vertex

getVertexX :: MonadIO m => Vertex -> m Float

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

get vertex #x

setVertexX :: MonadIO m => Vertex -> Float -> m ()

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

set vertex [ #x := value ]

y

Y coordinate of the vertex

getVertexY :: MonadIO m => Vertex -> m Float

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

get vertex #y

setVertexY :: MonadIO m => Vertex -> Float -> m ()

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

set vertex [ #y := value ]

z

Z coordinate of the vertex

getVertexZ :: MonadIO m => Vertex -> m Float

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

get vertex #z

setVertexZ :: MonadIO m => Vertex -> Float -> m ()

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

set vertex [ #z := value ]