Struct GLShaderNode

pub struct GLShaderNode { /* private fields */ }

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

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl GLShaderNode

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

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GskGLShaderNode) -> &Self

Borrows the underlying C value.

impl GLShaderNode

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

👎Deprecated: Since 4.16

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.

Deprecated since 4.16

GTK’s new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

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) -> Bytes

👎Deprecated: Since 4.16

Gets args for the node.

Deprecated since 4.16

GTK’s new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

Returns

A GBytes with the uniform arguments

pub fn n_children(&self) -> u32

👎Deprecated: Since 4.16

Returns the number of children

Deprecated since 4.16

GTK’s new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

Returns

The number of children

pub fn shader(&self) -> GLShader

Gets shader code for the node.

Returns

the GLShader shader

impl GLShaderNode

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

Gets one of the children.

Deprecated since 4.16

GTK’s new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

idx

the position of the child to get

Returns

the @idx’th child of @self

Methods from Deref<Target = RenderNode>

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

Return the inner pointer to the underlying C value.

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

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 opaque_rect(&self) -> Option<Rect>

Available on crate feature v4_16 only.

Gets an opaque rectangle inside the node that GTK can determine to be fully opaque.

There is no guarantee that this is indeed the largest opaque rectangle or that regions outside the rectangle are not opaque. This function is a best effort with that goal.

The rectangle will be fully contained in the bounds of the node.

Returns

true if part or all of the rendernode is opaque, false if no opaque region could be found.

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.

Returns

a GBytes representing the node.

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

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

pub fn is<T: IsRenderNode>(&self) -> bool

pub fn type_(&self) -> Type

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

Trait Implementations

impl AsRef<RenderNode> for GLShaderNode

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for GLShaderNode

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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<'a> FromValue<'a> for GLShaderNode

Available on crate feature v4_6 only.

type Checker = GenericValueTypeOrNoneChecker<GLShaderNode>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl IsRenderNode for GLShaderNode

const NODE_TYPE: RenderNodeType = RenderNodeType::GlShaderNode

fn upcast(self) -> RenderNode

fn upcast_ref(&self) -> &RenderNode

impl StaticType for GLShaderNode

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for GLShaderNode

Available on crate feature v4_6 only.

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ToValueOptional for GLShaderNode

Available on crate feature v4_6 only.

fn to_value_optional(s: Option<&Self>) -> Value

Convert an Option to a Value.

impl ValueType for GLShaderNode

Available on crate feature v4_6 only.

type Type = GLShaderNode

Type to get the Type from.