Gjsify LogoGjsify Logo

A render node for a linear gradient.

Hierarchy

Index

Constructors

  • Creates a GskRenderNode that will create a linear gradient from the given points and color stops, and render that into the area given by bounds.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the linear gradient into

    • start: Graphene.Point

      the point at which the linear gradient will begin

    • end: Graphene.Point

      the point at which the linear gradient will finish

    • colorStops: ColorStop[]

      a pointer to an array of GskColorStop defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1.

    Returns LinearGradientNode

Properties

name: string

Methods

  • Draw the contents of node to the given cairo context.

    Typically, you'll use this function to implement fallback rendering of GskRenderNodes on an intermediate Cairo context, instead of using the drawing context associated to a [classGdk.Surface]'s rendering buffer.

    For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail.

    Parameters

    Returns void

  • getNColorStops(): number
  • Retrieves the number of color stops in the gradient.

    Returns number

  • serialize(): any
  • Serializes the node for later deserialization via gsk_render_node_deserialize(). No guarantees are made about the format used other than that the same version of GTK will be able to deserialize the result of a call to gsk_render_node_serialize() and gsk_render_node_deserialize() will correctly reject files it cannot open that were created with previous versions of GTK.

    The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format.

    Returns any

  • unref(): void
  • Releases a reference on the given GskRenderNode.

    If the reference was the last, the resources associated to the node are freed.

    Returns void

  • writeToFile(filename: string): boolean
  • This function is equivalent to calling [methodGsk.RenderNode.serialize] followed by [funcGLib.file_set_contents].

    See those two functions for details on the arguments.

    It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection.

    Parameters

    • filename: string

      the file to save it to.

    Returns boolean

  • Loads data previously created via [methodGsk.RenderNode.serialize].

    For a discussion of the supported format, see that function.

    Parameters

    • bytes: any

      the bytes containing the data

    Returns RenderNode

  • Creates a GskRenderNode that will create a linear gradient from the given points and color stops, and render that into the area given by bounds.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the linear gradient into

    • start: Graphene.Point

      the point at which the linear gradient will begin

    • end: Graphene.Point

      the point at which the linear gradient will finish

    • colorStops: ColorStop[]

      a pointer to an array of GskColorStop defining the gradient. The offsets of all color stops must be increasing. The first stop's offset must be >= 0 and the last stop's offset must be <= 1.

    Returns LinearGradientNode

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method