Tristan Tarrant
129 lines
6.5 KiB
JavaScript
129 lines
6.5 KiB
JavaScript
//////////////////////////////////////////////////////////////////////////////////////////
|
|
// ) ( //
|
|
// ( /( ( ( ) ( ( ( ( )\ ) ( ( //
|
|
// )\()) ))\ )( ( ( )\ ) )\))( )\ ( (()/( ( )\))( ( //
|
|
// ((_)\ /((_|()\ )\ ) )\ '(()/( ((_)()((_) )\ ) ((_)))\((_)()\ )\ //
|
|
// | |(_|_))( ((_)_(_/( _((_)) )(_)) _(()((_|_)_(_/( _| |((_)(()((_|(_) //
|
|
// | '_ \ || | '_| ' \)) | ' \()| || | \ V V / | ' \)) _` / _ \ V V (_-< //
|
|
// |_.__/\_,_|_| |_||_| |_|_|_| \_, | \_/\_/|_|_||_|\__,_\___/\_/\_//__/ //
|
|
// |__/ //
|
|
//////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
'use strict';
|
|
|
|
import * as utils from '../utils.js';
|
|
|
|
// We import some modules only in the Shell process as they are not available in the
|
|
// preferences process. They are used only in the creator function of the ShaderFactory
|
|
// which is only called within GNOME Shell's process.
|
|
const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
|
|
const Cogl = await utils.importInShellOnly('gi://Cogl');
|
|
|
|
const _ = await utils.importGettext();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////
|
|
// This effect tears your windows apart with a series of violent scratches! //
|
|
// This effect is not available on GNOME 3.3x, due to the limitation described in the //
|
|
// documentation of vfunc_paint_target further down in this file. //
|
|
//////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// The effect class can be used to get some metadata (like the effect's name or supported
|
|
// GNOME Shell versions), to initialize the respective page of the settings dialog, as
|
|
// well as to create the actual shader for the effect.
|
|
export default class Effect {
|
|
|
|
// The constructor creates a ShaderFactory which will be used by extension.js to create
|
|
// shader instances for this effect. The shaders will be automagically created using the
|
|
// GLSL file in resources/shaders/<nick>.glsl. The callback will be called for each
|
|
// newly created shader instance.
|
|
constructor() {
|
|
this.shaderFactory = new ShaderFactory(Effect.getNick(), (shader) => {
|
|
// Create the texture in the first call.
|
|
if (!this._clawTexture) {
|
|
this._clawTexture = utils.getImageResource('/img/claws.png');
|
|
}
|
|
|
|
// Store uniform locations of newly created shaders.
|
|
shader._uClawTexture = shader.get_uniform_location('uClawTexture');
|
|
shader._uFlashColor = shader.get_uniform_location('uFlashColor');
|
|
shader._uSeed = shader.get_uniform_location('uSeed');
|
|
shader._uClawSize = shader.get_uniform_location('uClawSize');
|
|
shader._uNumClaws = shader.get_uniform_location('uNumClaws');
|
|
shader._uWarpIntensity = shader.get_uniform_location('uWarpIntensity');
|
|
|
|
// Write all uniform values at the start of each animation.
|
|
shader.connect('begin-animation', (shader, settings, forOpening, testMode) => {
|
|
// clang-format off
|
|
shader.set_uniform_float(shader._uFlashColor, 4, utils.parseColor(settings.get_string('trex-scratch-color')));
|
|
shader.set_uniform_float(shader._uSeed, 2, [testMode ? 0 : Math.random(), testMode ? 0 : Math.random()]);
|
|
shader.set_uniform_float(shader._uClawSize, 1, [settings.get_double('trex-scratch-scale')]);
|
|
shader.set_uniform_float(shader._uNumClaws, 1, [settings.get_int('trex-scratch-count')]);
|
|
shader.set_uniform_float(shader._uWarpIntensity, 1, [settings.get_double('trex-scratch-warp')]);
|
|
// clang-format on
|
|
});
|
|
|
|
// This is required to bind the claw texture for drawing. Sadly, this seems to be
|
|
// impossible under GNOME 3.3x as this.get_pipeline() is not available. It was
|
|
// called get_target() back then but this is not wrapped in GJS.
|
|
// https://gitlab.gnome.org/GNOME/mutter/-/blob/gnome-3-36/clutter/clutter/clutter-offscreen-effect.c#L598
|
|
shader.connect('update-animation', (shader) => {
|
|
const pipeline = shader.get_pipeline();
|
|
|
|
// Use linear filtering for the window texture.
|
|
pipeline.set_layer_filters(0, Cogl.PipelineFilter.LINEAR,
|
|
Cogl.PipelineFilter.LINEAR);
|
|
|
|
// Bind the claw texture.
|
|
pipeline.set_layer_texture(1, this._clawTexture.get_texture());
|
|
shader.setUniform1i(shader._uClawTexture, 1);
|
|
});
|
|
});
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------- metadata
|
|
|
|
// This effect is only available on GNOME Shell 40+.
|
|
static getMinShellVersion() {
|
|
return [40, 0];
|
|
}
|
|
|
|
// This will be called in various places where a unique identifier for this effect is
|
|
// required. It should match the prefix of the settings keys which store whether the
|
|
// effect is enabled currently (e.g. '*-enable-effect'), and its animation time
|
|
// (e.g. '*-animation-time').
|
|
static getNick() {
|
|
return 'trex';
|
|
}
|
|
|
|
// This will be shown in the sidebar of the preferences dialog as well as in the
|
|
// drop-down menus where the user can choose the effect.
|
|
static getLabel() {
|
|
return _('T-Rex Attack');
|
|
}
|
|
|
|
// -------------------------------------------------------------------- API for prefs.js
|
|
|
|
// This is called by the preferences dialog whenever a new effect profile is loaded. It
|
|
// binds all user interface elements to the respective settings keys of the profile.
|
|
static bindPreferences(dialog) {
|
|
dialog.bindAdjustment('trex-animation-time');
|
|
dialog.bindColorButton('trex-scratch-color');
|
|
dialog.bindAdjustment('trex-scratch-scale');
|
|
dialog.bindAdjustment('trex-scratch-count');
|
|
dialog.bindAdjustment('trex-scratch-warp');
|
|
}
|
|
|
|
// ---------------------------------------------------------------- API for extension.js
|
|
|
|
// The getActorScale() is called from extension.js to adjust the actor's size during the
|
|
// animation. This is useful if the effect requires drawing something beyond the usual
|
|
// bounds of the actor. This only works for GNOME 3.38+.
|
|
static getActorScale(settings, forOpening, actor) {
|
|
const scale = 1.0 + 0.5 * settings.get_double('trex-scratch-warp');
|
|
return {x: scale, y: scale};
|
|
}
|
|
}
|