Struct gsk4::GLShaderNode

pub struct GLShaderNode(_);

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

Implementations

impl GLShaderNode

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

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

pub fn args(&self) -> Option<Bytes>

Gets args for the node.

Returns

A GBytes with the uniform arguments

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

Gets one of the children.

idx

the position of the child to get

Returns

the idx’th child of self

pub fn n_children(&self) -> u32

Returns the number of children

Returns

The number of children

pub fn shader(&self) -> Option<GLShader>

Gets shader code for the node.

Returns

the GLShader shader

Methods from Deref<Target = RenderNode>

pub fn downcast_ref<T: IsRenderNode>(&self) -> Option<&T>

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

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

pub fn node_type(&self) -> RenderNodeType

Returns the type of the self.

Returns

the type of the RenderNode

pub fn serialize(&self) -> Bytes

Serializes the self for later deserialization via 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 serialize() and 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

a GBytes representing the node.

pub fn write_to_file<P: AsRef<Path>>(&self, filename: P) -> Result<(), Error>

This function is equivalent to calling serialize() followed by g_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.

filename

the file to save it to.

Returns

true if saving was successful

Trait Implementations

impl AsRef<RenderNode> for GLShaderNode

fn as_ref(&self) -> &RenderNode

Performs the conversion.

impl Clone for GLShaderNode

fn clone(&self) -> GLShaderNode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GLShaderNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for GLShaderNode

type Target = RenderNode

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for GLShaderNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for GLShaderNode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IsRenderNode for GLShaderNode

const NODE_TYPE: RenderNodeType

fn upcast(self) -> RenderNode

fn upcast_ref(&self) -> &RenderNode

impl Ord for GLShaderNode

fn cmp(&self, other: &GLShaderNode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GLShaderNode> for GLShaderNode

fn eq(&self, other: &GLShaderNode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GLShaderNode) -> bool

This method tests for !=.

impl PartialOrd<GLShaderNode> for GLShaderNode

fn partial_cmp(&self, other: &GLShaderNode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for GLShaderNode

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GLShaderNode

impl StructuralEq for GLShaderNode

impl StructuralPartialEq for GLShaderNode