zui docs v0.0.5
GitHub ↗
Drawing and interaction Container Native Qt

Shader Effect

A GPU shader surface with uniforms, source textures, time, pointer data, and frame events.

Usage

Ruby example

Paste this complete Builder example inside the app surface from the Quickstart. Replace illustrative asset paths with files from your project.

Ruby
shader_effect "assets/shaders/plasma.frag.qsb", width: 640, height: 360, running: true, intensity: 0.85
API

Component properties

35 component-specific values, plus shared item and layout properties.

shaderShader configuration for Shader Effect.property
fragment_shaderFragment shader configuration for Shader Effect.property
vertex_shaderVertex shader configuration for Shader Effect.property
widthWidth configuration for Shader Effect.property
heightHeight configuration for Shader Effect.property
blendingBlending configuration for Shader Effect.property
cull_modeCull mode configuration for Shader Effect.property
mesh_widthMesh width configuration for Shader Effect.property
mesh_heightMesh height configuration for Shader Effect.property
supports_atlasSupports atlas configuration for Shader Effect.property
source_rectSource rect configuration for Shader Effect.property
texture_widthTexture width configuration for Shader Effect.property
texture_heightTexture height configuration for Shader Effect.property
texture_formatTexture format configuration for Shader Effect.property
texture_samplesTexture samples configuration for Shader Effect.property
texture_wrapTexture wrap configuration for Shader Effect.property
texture_mirroringTexture mirroring configuration for Shader Effect.property
mipmapMipmap configuration for Shader Effect.property
liveLive configuration for Shader Effect.property
recursiveRecursive configuration for Shader Effect.property
timeTime configuration for Shader Effect.property
mouse_xMouse x configuration for Shader Effect.property
mouse_yMouse y configuration for Shader Effect.property
intensityIntensity configuration for Shader Effect.property
amountAmount configuration for Shader Effect.property
radiusRadius configuration for Shader Effect.property
progressProgress configuration for Shader Effect.property
frequencyFrequency configuration for Shader Effect.property
amplitudeAmplitude configuration for Shader Effect.property
colorColor configuration for Shader Effect.property
color2Color2 configuration for Shader Effect.property
parametersParameters configuration for Shader Effect.property
runningRunning configuration for Shader Effect.property
fpsFps configuration for Shader Effect.property
visibleVisible configuration for Shader Effect.property
Show 14 shared item properties
enabledopacityscalerotationzfill_widthfill_heightpreferred_widthpreferred_heightminimum_widthminimum_heightmaximum_widthmaximum_heightlayout_alignment
Interaction

Events

Subscribe with on widget, :event and keep behavior in Ruby.

statusNative event payload
frameNative event payload
clickNative event payload
hoverNative event payload
errorNative event payload