Skip to content

Creation of Videos help document #6235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 84 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 81 commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
6d7819b
Update WEB.md
sarashinai Apr 12, 2024
fdbc703
Create GALLERY.md
sarashinai Apr 13, 2024
cf5bdc4
Creation of GALLERY.md and related images
sarashinai Apr 13, 2024
3211fcf
Update GALLERY.md
sarashinai Apr 13, 2024
5c8e7b2
Update GALLERY.md
sarashinai Apr 13, 2024
9ea4144
Update GALLERY.md
sarashinai Apr 13, 2024
035c7bb
Update GALLERY.md
sarashinai Apr 13, 2024
49024ca
Update WEB.md
sarashinai Apr 12, 2024
1d677e7
Create GALLERY.md
sarashinai Apr 13, 2024
c8e6159
Creation of GALLERY.md and related images
sarashinai Apr 13, 2024
8e5d239
Update GALLERY.md
sarashinai Apr 13, 2024
67f6435
Update GALLERY.md
sarashinai Apr 13, 2024
07f5eee
Update GALLERY.md
sarashinai Apr 13, 2024
d9951d2
Update GALLERY.md
sarashinai Apr 13, 2024
1f125d0
Create VIDEOS.md
sarashinai Apr 15, 2024
ddcb127
Merge branch 'Documentation-Updates' of https://github.com/sarashinai…
sarashinai Apr 15, 2024
0e872ae
Update VIDEOS.md
sarashinai Apr 15, 2024
12b8c5f
Update VIDEOS.md
sarashinai Apr 15, 2024
7ebaa0c
Update VIDEOS.md
sarashinai Apr 15, 2024
99c1310
Update VIDEOS.md
sarashinai Apr 15, 2024
ff45e0f
Update VIDEOS.md
sarashinai Apr 15, 2024
4bf857e
Update VIDEOS.md
sarashinai Apr 15, 2024
ff473d3
Update VIDEOS.md
sarashinai Apr 15, 2024
cf1f740
Update VIDEOS.md
sarashinai Apr 15, 2024
fc346d1
Update VIDEOS.md
sarashinai Apr 15, 2024
a6fd522
Update VIDEOS.md
sarashinai Apr 15, 2024
315ed6d
Update VIDEOS.md
sarashinai Apr 15, 2024
886aa84
Update VIDEOS.md
sarashinai Apr 15, 2024
b89af09
Update VIDEOS.md
sarashinai Apr 15, 2024
a121906
Update VIDEOS.md
sarashinai Apr 15, 2024
1effdf5
Update VIDEOS.md
sarashinai Apr 15, 2024
13927f1
Update VIDEOS.md
sarashinai Apr 15, 2024
78fe2e7
Update VIDEOS.md
sarashinai Apr 15, 2024
7d60e0f
Update VIDEOS.md
sarashinai Apr 15, 2024
42fb5a8
Update VIDEOS.md
sarashinai Apr 15, 2024
300232a
Update VIDEOS.md
sarashinai Apr 15, 2024
50eea87
Update VIDEOS.md
sarashinai Apr 15, 2024
5c739a7
Update VIDEOS.md
sarashinai Apr 15, 2024
5ba3b66
Update VIDEOS.md
sarashinai Apr 16, 2024
85858af
Moved to help folder
sarashinai Apr 16, 2024
b431a4e
Update VIDEOS.md
sarashinai Apr 16, 2024
7397680
Update VIDEOS.md
sarashinai Apr 16, 2024
e03dc5d
Update VIDEOS.md
sarashinai Apr 16, 2024
a8b0894
Update VIDEOS.md
sarashinai Apr 16, 2024
d5467b0
Update VIDEOS.md
sarashinai Apr 16, 2024
71066c4
Update VIDEOS.md
sarashinai Apr 16, 2024
6b6e018
Update VIDEOS.md
sarashinai Apr 16, 2024
9ede4ab
Update VIDEOS.md
sarashinai Apr 16, 2024
33ba6f4
Update VIDEOS.md
sarashinai Apr 16, 2024
b379582
Update VIDEOS.md
sarashinai Apr 16, 2024
ceb6457
Update VIDEOS.md
sarashinai Apr 16, 2024
4e3d35a
Update VIDEOS.md
sarashinai Apr 16, 2024
040e59c
Update VIDEOS.md
sarashinai Apr 16, 2024
f4fe1ee
Update VIDEOS.md
sarashinai Apr 16, 2024
304eafa
Update VIDEOS.md
sarashinai Apr 16, 2024
6360be6
Update VIDEOS.md
sarashinai Apr 16, 2024
ed01f12
Update VIDEOS.md
sarashinai Apr 16, 2024
85b987b
Update VIDEOS.md
sarashinai Apr 16, 2024
56c2762
Update VIDEOS.md
sarashinai Apr 16, 2024
f784169
Update VIDEOS.md
sarashinai Apr 16, 2024
df2df6c
Update VIDEOS.md
sarashinai Apr 16, 2024
2f51885
Update VIDEOS.md
sarashinai Apr 16, 2024
daa4fcd
Update VIDEOS.md
sarashinai Apr 16, 2024
a609f75
Update VIDEOS.md
sarashinai Apr 16, 2024
cf72888
Update VIDEOS.md
sarashinai Apr 16, 2024
6724461
Update VIDEOS.md
sarashinai Apr 16, 2024
066ca4d
Update VIDEOS.md
sarashinai Apr 16, 2024
d56f365
Update VIDEOS.md
sarashinai Apr 16, 2024
679b3fe
More descriptions
sarashinai Apr 16, 2024
4440072
Update VIDEOS.md
sarashinai Apr 16, 2024
fd9f956
Update VIDEOS.md
sarashinai Apr 16, 2024
18e815d
Update VIDEOS.md
sarashinai Apr 16, 2024
67a5eca
Update VIDEOS.md
sarashinai Apr 16, 2024
217cb7d
Update VIDEOS.md
sarashinai Apr 16, 2024
b29e3d8
Update VIDEOS.md
sarashinai Apr 17, 2024
6fed7d6
Update VIDEOS.md
sarashinai Apr 17, 2024
4708585
Update VIDEOS.md
sarashinai Apr 17, 2024
02b7aa4
Update VIDEOS.md
sarashinai Apr 17, 2024
d8abfab
Update VIDEOS.md
sarashinai Apr 17, 2024
1043287
Update VIDEOS.md
sarashinai Apr 17, 2024
eea7cf0
Update VIDEOS.md
sarashinai Apr 17, 2024
d48006d
Merge branch 'main' into Documentation-Updates
hipsterusername May 26, 2024
8fe57d6
Merge branch 'main' into Documentation-Updates
hipsterusername May 26, 2024
cb25c9f
Merge branch 'main' into Documentation-Updates
hipsterusername May 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/gallery/board_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/board_tabs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/board_thumbnails.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/gallery.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/image_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/info_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/thumbnail_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gallery/top_controls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 92 additions & 0 deletions docs/features/GALLERY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
title: InvokeAI Gallery Panel
---

# :material-web: InvokeAI Gallery Panel

## Quick guided walkthrough of the Gallery Panel's features

The Gallery Panel is a fast way to review, find, and make use of images you've
generated and loaded. The Gallery is divided into Boards. The Uncategorized board is always
present but you can create your own for better organization.

![image](../assets/gallery/gallery.png)

### Board Display and Settings

At the very top of the Gallery Panel are the boards disclosure and settings buttons.

![image](../assets/gallery/top_controls.png)

The disclosure button shows the name of the currently selected board and allows you to show and hide the board thumbnails (shown in the image below).

![image](../assets/gallery/board_thumbnails.png)

The settings button opens a list of options.

![image](../assets/gallery/board_settings.png)

- ***Image Size*** this slider lets you control the size of the image previews (images of three different sizes).
- ***Auto-Switch to New Images*** if you turn this on, whenever a new image is generated, it will automatically be loaded into the current image panel on the Text to Image tab and into the result panel on the [Image to Image](IMG2IMG.md) tab. This will happen invisibly if you are on any other tab when the image is generated.
- ***Auto-Assign Board on Click*** whenever an image is generated or saved, it always gets put in a board. The board it gets put into is marked with AUTO (image of board marked). Turning on Auto-Assign Board on Click will make whichever board you last selected be the destination when you click Invoke. That means you can click Invoke, select a different board, and then click Invoke again and the two images will be put in two different boards. (bold)It's the board selected when Invoke is clicked that's used, not the board that's selected when the image is finished generating.(bold) Turning this off, enables the Auto-Add Board drop down which lets you set one specific board to always put generated images into. This also enables and disables the Auto-add to this Board menu item described below.
- ***Always Show Image Size Badge*** this toggles whether to show image sizes for each image preview (show two images, one with sizes shown, one without)

Below these two buttons, you'll see the Search Boards text entry area. You use this to search for specific boards by the name of the board.
Next to it is the Add Board (+) button which lets you add new boards. Boards can be renamed by clicking on the name of the board under its thumbnail and typing in the new name.

### Board Thumbnail Menu

Each board has a context menu (ctrl+click / right-click).

![image](../assets/gallery/thumbnail_menu.png)

- ***Auto-add to this Board*** if you've disabled Auto-Assign Board on Click in the board settings, you can use this option to set this board to be where new images are put.
- ***Download Board*** this will add all the images in the board into a zip file and provide a link to it in a notification (image of notification)
- ***Delete Board*** this will delete the board
> [!CAUTION]
> This will delete all the images in the board and the board itself.

### Board Contents

Every board is organized by two tabs, Images and Assets.

![image](../assets/gallery/board_tabs.png)

Images are the Invoke-generated images that are placed into the board. Assets are images that you upload into Invoke to be used as an [Image Prompt](https://support.invoke.ai/support/solutions/articles/151000159340-using-the-image-prompt-adapter-ip-adapter-) or in the [Image to Image](IMG2IMG.md) tab.

### Image Thumbnail Menu

Every image generated by Invoke has its generation information stored as text inside the image file itself. This can be read directly by selecting the image and clicking on the Info button ![image](../assets/gallery/info_button.png) in any of the image result panels.

Each image also has a context menu (ctrl+click / right-click).

![image](../assets/gallery/image_menu.png)

The options are (items marked with an * will not work with images that lack generation information):
- ***Open in New Tab*** this will open the image alone in a new browser tab, separate from the Invoke interface.
- ***Download Image*** this will trigger your browser to download the image.
- ***Load Workflow **** this will load any workflow settings into the Workflow tab and automatically open it.
- ***Remix Image **** this will load all of the image's generation information, (bold)excluding its Seed, into the left hand control panel
- ***Use Prompt **** this will load only the image's text prompts into the left-hand control panel
- ***Use Seed **** this will load only the image's Seed into the left-hand control panel
- ***Use All **** this will load all of the image's generation information into the left-hand control panel
- ***Send to Image to Image*** this will put the image into the left-hand panel in the Image to Image tab ana automatically open it
- ***Send to Unified Canvas*** This will (bold)replace whatever is already present(bold) in the Unified Canvas tab with the image and automatically open the tab
- ***Change Board*** this will oipen a small window that will let you move the image to a different board. This is the same as dragging the image to that board's thumbnail.
- ***Star Image*** this will add the image to the board's list of starred images that are always kept at the top of the gallery. This is the same as clicking on the star on the top right-hand side of the image that appears when you hover over the image with the mouse
- ***Delete Image*** this will delete the image from the board
> [!CAUTION]
> This will delete the image entirely from Invoke.

## Summary

This walkthrough only covers the Gallery interface and Boards. Actually generating images is handled by [Prompts](PROMPTS.md), the [Image to Image](IMG2IMG.md) tab, and the [Unified Canvas](UNIFIED_CANVAS.md).

## Acknowledgements

A huge shout-out to the core team working to make the Web GUI a reality,
including [psychedelicious](https://github.com/psychedelicious),
[Kyle0654](https://github.com/Kyle0654) and
[blessedcoolant](https://github.com/blessedcoolant).
[hipsterusername](https://github.com/hipsterusername) was the team's unofficial
cheerleader and added tooltips/docs.
2 changes: 1 addition & 1 deletion docs/features/WEB.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ main sections:
of buttons at the top lets you modify and manipulate the image in
various ways.

3. A **gallery** section on the left that contains a history of the images you
3. A **gallery** section on the right that contains a history of the images you
have generated. These images are read and written to the directory specified
in the `INVOKEAIROOT/invokeai.yaml` initialization file, usually a directory
named `outputs` in `INVOKEAIROOT`.
Expand Down
Loading