Functions¶

	`box_empty` ()
	`box_infinite` ()
	`box_minus_one` ()
	`box_one` ()
	`box_one_minus_one` ()
	`box_zero` ()
	`point3d_zero` ()
	`point_zero` ()
	`rect_alloc` ()
	`rect_zero` ()
	`size_zero` ()
	`vec2_one` ()
	`vec2_x_axis` ()
	`vec2_y_axis` ()
	`vec2_zero` ()
	`vec3_one` ()
	`vec3_x_axis` ()
	`vec3_y_axis` ()
	`vec3_z_axis` ()
	`vec3_zero` ()
	`vec4_one` ()
	`vec4_w_axis` ()
	`vec4_x_axis` ()
	`vec4_y_axis` ()
	`vec4_z_axis` ()
	`vec4_zero` ()

Details¶

Graphene.box_empty()¶

Returns:: a Graphene.Box
Return type:: Graphene.Box

A degenerate Graphene.Box that can only be expanded.

The returned value is owned by Graphene and should not be modified or freed.

Added in version 1.2.

Graphene.box_infinite()¶

Returns:: a Graphene.Box
Return type:: Graphene.Box

A degenerate Graphene.Box that cannot be expanded.

The returned value is owned by Graphene and should not be modified or freed.

Added in version 1.2.

Graphene.box_minus_one()¶

Returns:: a Graphene.Box
Return type:: Graphene.Box

A Graphene.Box with the minimum vertex set at (-1, -1, -1) and the maximum vertex set at (0, 0, 0).

The returned value is owned by Graphene and should not be modified or freed.

Added in version 1.2.

Graphene.box_one()¶

Returns:: a Graphene.Box
Return type:: Graphene.Box

A Graphene.Box with the minimum vertex set at (0, 0, 0) and the maximum vertex set at (1, 1, 1).

The returned value is owned by Graphene and should not be modified or freed.

Added in version 1.2.

Graphene.box_one_minus_one()¶

Returns:: a Graphene.Box
Return type:: Graphene.Box

A Graphene.Box with the minimum vertex set at (-1, -1, -1) and the maximum vertex set at (1, 1, 1).

The returned value is owned by Graphene and should not be modified or freed.

Added in version 1.2.

Graphene.box_zero()¶

Returns:: a Graphene.Box
Return type:: Graphene.Box

A Graphene.Box with both the minimum and maximum vertices set at (0, 0, 0).

The returned value is owned by Graphene and should not be modified or freed.

Added in version 1.2.

Graphene.point3d_zero()¶

Returns:: a zero point
Return type:: Graphene.Point3D

Retrieves a constant point with all three coordinates set to 0.

Added in version 1.0.

Graphene.point_zero()¶

Returns:: a fixed point
Return type:: Graphene.Point

Returns a point fixed at (0, 0).

Added in version 1.0.

Graphene.rect_alloc()¶

Returns:: the newly allocated rectangle
Return type:: Graphene.Rect

Allocates a new Graphene.Rect.

The contents of the returned rectangle are undefined.

Added in version 1.0.

Graphene.rect_zero()¶

Returns:: a fixed rectangle
Return type:: Graphene.Rect

Returns a degenerate rectangle with origin fixed at (0, 0) and a size of 0, 0.

Added in version 1.4.

Graphene.size_zero()¶

Returns:: a constant size
Return type:: Graphene.Size

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

Added in version 1.0.

Graphene.vec2_one()¶

Returns:: the one vector
Return type:: Graphene.Vec2

Retrieves a constant vector with (1, 1) components.

Added in version 1.0.

Graphene.vec2_x_axis()¶

Returns:: the X axis vector
Return type:: Graphene.Vec2

Retrieves a constant vector with (1, 0) components.

Added in version 1.0.

Graphene.vec2_y_axis()¶

Returns:: the Y axis vector
Return type:: Graphene.Vec2

Retrieves a constant vector with (0, 1) components.

Added in version 1.0.

Graphene.vec2_zero()¶

Returns:: the zero vector
Return type:: Graphene.Vec2

Retrieves a constant vector with (0, 0) components.

Added in version 1.0.

Graphene.vec3_one()¶

Returns:: a constant vector
Return type:: Graphene.Vec3

Provides a constant pointer to a vector with three components, all sets to 1.

Added in version 1.0.

Graphene.vec3_x_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec3

Provides a constant pointer to a vector with three components with values set to (1, 0, 0).

Added in version 1.0.

Graphene.vec3_y_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec3

Provides a constant pointer to a vector with three components with values set to (0, 1, 0).

Added in version 1.0.

Graphene.vec3_z_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec3

Provides a constant pointer to a vector with three components with values set to (0, 0, 1).

Added in version 1.0.

Graphene.vec3_zero()¶

Returns:: a constant vector
Return type:: Graphene.Vec3

Provides a constant pointer to a vector with three components, all sets to 0.

Added in version 1.0.

Graphene.vec4_one()¶

Returns:: a constant vector
Return type:: Graphene.Vec4

Retrieves a pointer to a Graphene.Vec4 with all its components set to 1.

Added in version 1.0.

Graphene.vec4_w_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec4

Retrieves a pointer to a Graphene.Vec4 with its components set to (0, 0, 0, 1).

Added in version 1.0.

Graphene.vec4_x_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec4

Retrieves a pointer to a Graphene.Vec4 with its components set to (1, 0, 0, 0).

Added in version 1.0.

Graphene.vec4_y_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec4

Retrieves a pointer to a Graphene.Vec4 with its components set to (0, 1, 0, 0).

Added in version 1.0.

Graphene.vec4_z_axis()¶

Returns:: a constant vector
Return type:: Graphene.Vec4

Retrieves a pointer to a Graphene.Vec4 with its components set to (0, 0, 1, 0).

Added in version 1.0.

Graphene.vec4_zero()¶

Returns:: a constant vector
Return type:: Graphene.Vec4

Retrieves a pointer to a Graphene.Vec4 with all its components set to 0.

Added in version 1.0.