ShaderWB User Documentation

1. Introduction

ShaderWB is an software program for playing with shaders. It is currently available as pre-alpha and runs on MS WIndows.

The major purpose of ShaderWB is to set up new shaders fast with a direct visual output and no need to recompile anything. You can write your shader code and you will either get the error report or see the shaders' result.

In this given pre-alpha version, only texture rendering is possible. This means that your shader is applied to a plain plane, nothing more. Further use cases will be added in subsequent versions - if someone shows interest. Please give us some feedback by writing to daniel@krajzewicz.de.

This user documentation is structured as following: Chapter 2 gives an overview about ShaderWB's main window and its components. Chapter 3 lists the actions accessible in the menu bar. Chapter 4 lists contact possibilities and further sources of information.

2. ShaderWB's Graphical User Interface

The main window is divided into different sections or components. The main window is shown in the following image. The components it consists of are described in the following.

Figure 2.1. Main ShaderWB window.

Main ShaderWB window.

2.1. Project Tree

The project tree shows the used shader files. The project tree is highlighted in the following image.

Figure 2.2. Main ShaderWB window with highlighted project tree.

Main ShaderWB window with highlighted project tree.

2.2. Shader Code Editor

The shader code editor is a text editor you can type your shader code into. The editor support clipboard actions, such as cut, copy or paste, as well as undo/redo. You may switch between the fragment and the vertex shader using the combo box that is located above the editor. The shader code editor is highlighted in the following image.

Figure 2.3. Main ShaderWB window with highlighted shader code editor.

Main ShaderWB window with highlighted shader code editor.

2.3. Error Viewer

When any errors occur during shader compilation, they are shown in the error viewer. The error viewer is highlighted in the following image.

Figure 2.4. Main ShaderWB window with highlighted error viewer.

Main ShaderWB window with highlighted error viewer.

2.4. Viewer

The viewer contains the result of the image generated when applying the shader. The viewer is highlighted in the following image.

Figure 2.5. Main ShaderWB window with highlighted viewer.

Main ShaderWB window with highlighted viewer.

2.5. Menu Bar

The menu bar is highlighted in the following image.

Figure 2.6. Main ShaderWB window with highlighted menu bar.

Main ShaderWB window with highlighted menu bar.

The menu bar contains all the actions ShaderWB is capable to perform. It is the major interface between the user and ShaderWB. Thereby, Chapter 3 is completely denoted to list the actions that can be found in the menu bar.

2.6. Tool Bar

The tool bar is highlighted in the following image. It contains shortcuts the most often used actions.

Figure 2.7. Main ShaderWB window with highlighted tool bar.

Main ShaderWB window with highlighted tool bar.

2.7. Status Bar

The status bar is highlighted in the following image.

Figure 2.8. Main ShaderWB window with highlighted status bar.

Main ShaderWB window with highlighted status bar.

When hovering above a menu bar or a tool bar entry, the status bar shows a coarse description of the according action. In addition, the status bar shows an according message when a new file was loaded or saved.

3. ShaderWB Actions

All of ShaderWB's functionality is accessed using the actions to be found in the menu bar. The actions are grouped into the following topics:

  • File: Holds actions for loading, saving, and exporting files and for printing, see "The 'File' Menu",

  • Edit: Holds actions for editing the palette and selected entries, see "The 'Edit' Menu";

  • Help: Holds actions for display ShaderWB's about and help dialog, see "The 'Help' Menu".

The menus are described in the following subsections.

3.1. The 'File' Menu

The File menu allows you to load and save projects, images, and color palettes from/to different formats. Additionally, a loaded palette can be exported as an image or into diverse text formats. As well, both images, and palettes can be printed. The File menu contains the following entries:

  • New: Generates a new, empty project, see "New";

  • Open...: Opens an existing project file, see "Open...";

  • Save: Saves the current project, see "Save";

  • Save as...: Saves the current project under a new name, see "Save as...";

  • Open recent: Opens a previously loaded or saved file, see "Open recent";

  • Clear recent files: Clears the list of recent files, see "Clear recent files";

  • Exit: Quits the application, see "Exit".

The actions within the File menu will be described in the following.

3.1.1. New

A new project will be initialised consisting of a simple vertex shader and a fragment shader that renders a Julia fractal.

If the project tool bar is shown, you may as well click on the according icon () to instantiate a new project.

3.1.2. Open...

This action loads an existing project from the file system.

If the project tool bar is shown, you may as well click on the according icon () to load a project.

3.1.3. Save

If a project was loaded and modified you can save the changes to the project by choosing this item. If the project was not saved before, a dialog will be shown where you can select the folder to save the project into and define the project's file name.

If the project tool bar is shown, you may as well click on the according icon () to save a project.

3.1.4. Save as...

Choosing this item will show a dialog where you can select the folder to save the project into and its name.

If the project tool bar is shown, you may as well click on the according icon () to save a project under a new name.

3.1.5. Open recent...

Behind this entry, you may find a list of previously loaded or saved files. When selected, the according file will be loaded.

3.1.6. Clear recent

Selecting this action will empty the list of previously loaded files.

3.1.7. Exit

Quits the application. If either the palette or the image were not saved, a dialog will pop up before asking whether they should be saved.

3.2. The 'Edit' Menu

The Edit menu holds actions for undoing/redoing editing, for basic clipboard options, and for selecting text within the shader editor:

  • Undo: Undos the last action, see "Undo";

  • Redo: Redos the last action, see "Redo";

  • Cut: Cuts the selected part of the text in the shader editor, copying it to the clipboard, see "Cut";

  • Copy: Copies the selected part of the text in the shader editor to the clipboard, see "Copy";

  • Paste: Pastes text from the clipboard the shader editor at the cursor's position, see "Paste";

  • Delete: Delets the selected text, see "Delete";

  • Select all: Selects the complete text in the text editor, see "Select all";

  • Select none: Deselects all, see "Select none";

The actions within the Edit menu will be described in the following.

3.2.1. Undo

Undo reverts the last action or text edit.

If the undo/redo tool bar is shown, you may as well click on the according icon () to undo the last action.

3.2.2. Redo

Redo re-performs the last undone actionor text edit.

If the undo/redo tool bar is shown, you may as well click on the according icon () to redo the last undone action.

3.2.3. Cut

Cut removes the selected part of the text in the shader editor, copying it into the clipboard. After cutting the text, the current selection is removed.

The action can be only performed if at least one character is selected.

If the edit tool bar is shown, you may as well click on the according icon () to remove selected palette entries while copying them to the clipboard.

3.2.4. Copy

The selected part of the text in the shader editor is copied into the clipboard.

The action can be only performed if at least one character is selected.

If the edit tool bar is shown, you may as well click on the according icon () to copy selected palette entries.

3.2.5. Paste

Text within the clipboard is copied to the shader editor at the cursor's position. The action can only be performed if the clipboard contains text.

If the edit tool bar is shown, you may as well click on the according icon () to paste colors from the clipboard into the palette.

3.2.6. Delete

The action removes the selected part of the text in the shader editor. After deleting text, the current selection is removed.

If the edit tool bar is shown, you may as well click on the according icon () to delete selected palette entries.

3.2.7. Select all

This action selects the complete text in the shader editor.

3.2.8. Select none

This action deselects all.

3.3. The 'Help' Menu

The Help menu holds actions for interacting with the image view. The Help menu contains the following entries:

  • About: shows some information about the application, see About;

  • Help: opens the help dialog, see Help;

The actions within the Help menu will be described in the following.

3.3.1. About

This action shows the application about dialog which contains some basic information about ShaderWB.

If the help tool bar is shown, you may as well click on the according icon () to show the about dialog.

3.3.2. Help

This action opens the help dialog. The help dialog includes the same information as the user documentation, yet browsable off-line in the application's context. The dialog looks like the following:

Figure 3.1. The Help dialog.

The Help dialog.

If the help tool bar is shown, you may as well click on the according icon () to show the help dialog.

4. Contact and Further Information

ShaderWB has a web page at http://www.krajzewicz.de/blog/announcing_shaderwb.php. You may contact us by writing to daniel@krajzewicz.de.

ShaderWB is a product of:

Daniel Krajzewicz
Jochen-Nüßler-Straße 5
12359 Berlin
USt-IdNr.: DE281155133

Legal Information

Daniel Krajzewicz Jochen-Nüßler-Straße 5
12359 Berlin
USt-IdNr.: DE281155133
© Copyright 2009-2022 Daniel Krajzewicz
Last changed on August 27 2022 19:58:21.
150 visitors.
Contact: info@palettewb.com