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
impl GLShaderNode
source§impl GLShaderNode
impl GLShaderNode
sourcepub fn new(
shader: &GLShader,
bounds: &Rect,
args: &Bytes,
children: &[RenderNode]
) -> GLShaderNode
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
sourcepub fn n_children(&self) -> u32
pub fn n_children(&self) -> u32
source§impl GLShaderNode
impl GLShaderNode
Methods from Deref<Target = RenderNode>§
pub const NONE: Option<&'static RenderNode> = None
sourcepub fn draw(&self, cr: &Context)
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 RenderNode
s 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
sourcepub fn node_type(&self) -> RenderNodeType
pub fn node_type(&self) -> RenderNodeType
sourcepub fn serialize(&self) -> Bytes
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.
sourcepub fn write_to_file(&self, filename: impl AsRef<Path>) -> Result<(), Error>
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§
source§impl AsRef<RenderNode> for GLShaderNode
impl AsRef<RenderNode> for GLShaderNode
source§fn as_ref(&self) -> &RenderNode
fn as_ref(&self) -> &RenderNode
source§impl Clone for GLShaderNode
impl Clone for GLShaderNode
source§impl Debug for GLShaderNode
impl Debug for GLShaderNode
source§impl Deref for GLShaderNode
impl Deref for GLShaderNode
source§impl Display for GLShaderNode
impl Display for GLShaderNode
source§impl<'a> FromValue<'a> for GLShaderNode
Available on crate feature v4_6
only.
impl<'a> FromValue<'a> for GLShaderNode
v4_6
only.§type Checker = GenericValueTypeOrNoneChecker<GLShaderNode>
type Checker = GenericValueTypeOrNoneChecker<GLShaderNode>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl IsRenderNode for GLShaderNode
impl IsRenderNode for GLShaderNode
const NODE_TYPE: RenderNodeType = RenderNodeType::GlShaderNode
fn upcast(self) -> RenderNode
fn upcast_ref(&self) -> &RenderNode
source§impl StaticType for GLShaderNode
impl StaticType for GLShaderNode
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl ToValue for GLShaderNode
Available on crate feature v4_6
only.
impl ToValue for GLShaderNode
v4_6
only.source§impl ToValueOptional for GLShaderNode
Available on crate feature v4_6
only.
impl ToValueOptional for GLShaderNode
v4_6
only.source§impl ValueType for GLShaderNode
Available on crate feature v4_6
only.
impl ValueType for GLShaderNode
v4_6
only.§type Type = GLShaderNode
type Type = GLShaderNode
Type
from. Read more