Struct gsk4::GLShaderNode

source ·

#[repr(transparent)]
pub struct GLShaderNode { /* private fields */ }

Expand description

A render node using a GL shader when drawing its children nodes.

Implementations§

source §

impl GLShaderNode

source

pub fn as_ptr(&self) -> *mut GskGLShaderNode

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: const const GskGLShaderNode ) -> &'a Self

Borrows the underlying C value.

source §

impl GLShaderNode

source

pub fn new( shader: &GLShader, bounds: &Rect, args: &Bytes, children: &[RenderNode] ) -> GLShaderNode

Creates a RenderNode that will render the given @shader into the area given by @bounds.

The @args is a block of data to use for uniform input, as per types and offsets defined by the @shader. Normally this is generated by Gsk::GLShader::format_args() or ShaderArgsBuilder.

See GLShader for details about how the shader should be written.

All the children will be rendered into textures (if they aren’t already GskTextureNodes, which will be used directly). These textures will be sent as input to the shader.

If the renderer doesn’t support GL shaders, or if there is any problem when compiling the shader, then the node will draw pink. You should use GLShader::compile() to ensure the @shader will work for the renderer before using it.

`shader`

the GLShader

`bounds`

the rectangle to render the shader into

`args`

Arguments for the uniforms

`children`

array of child nodes, these will be rendered to textures and used as input.

Returns

A new RenderNode

source

pub fn args(&self) -> Bytes

Gets args for the node.

Returns

A GBytes with the uniform arguments

source

pub fn n_children(&self) -> u32

Returns the number of children

Returns

The number of children

source

pub fn shader(&self) -> GLShader

Gets shader code for the node.

Returns

the GLShader shader

source §

impl GLShaderNode

source

pub fn child(&self, idx: u32) -> RenderNode

Gets one of the children.

`idx`

the position of the child to get

Returns

the @idx’th child of @self

Methods from Deref<Target = RenderNode>§

source

pub fn as_ptr(&self) -> *mut GskRenderNode

Return the inner pointer to the underlying C value.

source

pub const NONE: Option<&'static RenderNode> = None

source

pub fn draw(&self, cr: &Context)

Draw the contents of @self to the given cairo context.

Typically, you’ll use this function to implement fallback rendering of RenderNodes on an intermediate Cairo context, instead of using the drawing context associated to a gdk::Surface’s rendering buffer.

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

`cr`

cairo context to draw to

source

pub fn bounds(&self) -> Rect

Retrieves the boundaries of the @self.

The node will not draw outside of its boundaries.

Returns

`bounds`

return location for the boundaries

source

pub fn node_type(&self) -> RenderNodeType

Returns the type of the @self.

Returns

the type of the RenderNode

source

pub fn serialize(&self) -> Bytes

Serializes the @self 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.