Difference between revisions of "Layout Editor:Layering & Transparency"
(12 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | |||
= Introduction = | = Introduction = | ||
− | The layout system in Wah!Cade | + | The layout system in Wah!Cade constructs the screen using artwork as layers. These layers support transparency. Transparency must enabled in the item properties dialog when editing the item using the Layout Editor. We can take advantage of the way the screen is constructed to assist with generating complex composited layouts. |
− | [[File:LayoutEditorLayersIllustration.png]] | + | [[File:LayoutEditorLayersIllustration.png|thumb|Wah!Cade Layers]] |
By default the layout system supports 3 major types of graphics. Each of these are used when building composited layouts in order of preference. | By default the layout system supports 3 major types of graphics. Each of these are used when building composited layouts in order of preference. | ||
− | # Empty Artwork 1-10 ''( | + | # Empty Artwork 1-10 ''(Static artwork displayed when no artwork is found)'' |
# Artwork 1-10 | # Artwork 1-10 | ||
# Background Images | # Background Images | ||
− | |||
− | |||
== Artwork Types == | == Artwork Types == | ||
=== Empty Artwork === | === Empty Artwork === | ||
− | + | The Empty Artwork feature in Wah!Cade displays a "Game Not Found" image. When using composited layouts you will take advantage of this feature to load graphics as layers throughout your layout. Empty Artwork graphics can be used in any of the Artwork 1-10 items. These items support transparency, as do PNG and GIF images. Combining these artwork widgets with graphic files is how we will construct layered layouts. | |
The [http://bazaar.launchpad.net/%7Eandy-balcombe/wahcade/main/annotate/head%3A/doc/LAYOUT_EDITOR LAYOUT_EDITOR] Documentation details the naming conventions available. | The [http://bazaar.launchpad.net/%7Eandy-balcombe/wahcade/main/annotate/head%3A/doc/LAYOUT_EDITOR LAYOUT_EDITOR] Documentation details the naming conventions available. | ||
− | + | Using Empty Artwork as part of your layout will limit the number of dynamic Artwork items available once the base layout is built. This will need to be a consideration when planning a layout. | |
− | |||
− | + | When using Empty Artwork items in your layout you will to add all the required Artwork items in the Layout Editor. | |
+ | You can customise the layout on the fly if you have used Empty Artwork by adding images using a game name in the artwork directory used by the layout. | ||
− | + | === Artwork 1-10 === | |
+ | Artwork items is the only method available for displaying dynamic artwork in a layout. | ||
=== Background Images === | === Background Images === | ||
− | Background images are static images, these items do not support transparency. | + | Background images are static images, these items do not support transparency and are therefore limited in their application. |
== N64 Layout Example == | == N64 Layout Example == | ||
=== Information === | === Information === | ||
− | In this N64 Layout example there is no background image file used for the layout. The layout is built completely from artworks 1 through 10. The ''static'' layout is built from | + | In this N64 Layout example there is no background image file used for the layout. The layout is built completely from artworks 1 through 10. The ''static'' layout is built from empty artwork files as mentioned previously. To make use of the empty artwork we intentionally break the artwork path for the artwork item. As a consideration, the ''intentional break'' is actually linked to an empty folder to allow for customisation in the future. |
− | |||
− | |||
− | |||
− | |||
− | All 10 layers of this layout are customisable | + | All 10 layers of this layout are customisable. For example you may choose to change ''(based on the item selected)'' |
+ | * The characters displayed on screen ''(Artwork 8)'' | ||
+ | * The colour of the main background ''(Artwork 4)'' | ||
+ | * The main background to a game background ''(Artwork 4)'' | ||
+ | * The console & controller images ''(Artwork 6)'' | ||
+ | * The console & controller images to a controller configuration information graphic ''(Artwork 6)'' | ||
+ | * The overlay used for the snap and title images ''(Artwork 3)'' | ||
+ | * The emulator logo ''(Artwork 9)'' | ||
− | === | + | === Breaking Down The Layers === |
− | [[File: | + | {|width=100% |
− | '' | + | |[[File:Layout_Editor-Layering_&_Transparency-N64-art1.png|thumb|''n64-art1.png'']] |
+ | ''' Artwork 1 '''<br /> | ||
+ | * Artwork 1 is reserved for dynamic artwork (snaps, titles etc). | ||
+ | * An image is used as an empty image for the layout to be displayed when a selection image is not available. | ||
+ | * This is the standard behaviour of the empty image. | ||
+ | * In this example Artwork 1 is displaying snapshots. | ||
+ | * artwork_1_image_path is configured in the emulator ini, links to folder containing snaps | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art2.png|thumb|''n64-art2.png'']] | ||
+ | ''' Artwork 2 '''<br /> | ||
+ | * Artwork 2 is reserved for dynamic artwork (snaps, titles etc). | ||
+ | * An image is used as an empty image for the layout to be displayed when a selection image is not available | ||
+ | * This is the standard behaviour of the empty image. | ||
+ | * In this example Artwork 2 is displaying titles. | ||
+ | * artwork_2_image_path is configured in the emulator ini, links to folder containing titles | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art3.png|thumb|''n64-art3.png'']] | ||
+ | ''' Artwork 3 '''<br /> | ||
+ | * Artwork 3 is a static empty image. | ||
+ | * In this example Artwork 3 is used as an overlay for Artwork 1 & Artwork 2 adding a scanlines effect to the dynamic images. | ||
+ | * artwork_3_image_path is configured in the emulator ini, links to an empty folder | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art4.png|thumb|''n64-art4.png'']] | ||
+ | ''' Artwork 4 '''<br /> | ||
+ | * Artwork 4 is a static empty image. | ||
+ | * Artwork 4 is the main background (previously would be main.png in older layout methods) | ||
+ | * In this example Artwork 4 overlays the previous 3 layers hiding inconsistent/oversized image edges beneath it. | ||
+ | * artwork_4_image_path is configured in the emulator ini, links to an empty folder | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art5.png|thumb|''n64-art5.png'']] | ||
+ | ''' Artwork 5 '''<br /> | ||
+ | * Artwork 5 is reserved for dynamic artwork (snaps, titles etc). | ||
+ | * An image is used as an empty image for the layout to be displayed when a selection image is not available | ||
+ | * This is the standard behaviour of the empty image. | ||
+ | * In this example Artwork 5 is displaying 3D box images. | ||
+ | * artwork_5_image_path is configured in the emulator ini, links to folder containing boxart | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art6.png|thumb|''n64-art6.png'']] | ||
+ | ''' Artwork 6 '''<br /> | ||
+ | * Artwork 6 is a static empty image. | ||
+ | * Artwork 6 is the console & controller overlay | ||
+ | * artwork_6_image_path is configured in the emulator ini, links to an empty folder | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art7.png|thumb|''n64-art7.png'']] | ||
+ | ''' Artwork 7 '''<br /> | ||
+ | * Artwork 7 is reserved for dynamic artwork (snaps, titles etc). | ||
+ | * A small transparent image is used to make the artwork widget appear blank to the user. | ||
+ | * An image is used as an empty image for the layout to be displayed when a selection image is not available | ||
+ | * This is the standard behaviour of the empty image. In this example Artwork 7 is displaying Hyperspin wheel art images. | ||
+ | * artwork_7_image_path is configured in the emulator ini, links to folder containing wheel art images | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art8.png|thumb|''n64-art8.png'']] | ||
+ | ''' Artwork 8 '''<br /> | ||
+ | * Artwork 8 is a static empty image. | ||
+ | * Artwork 8 is the characters overlay | ||
+ | * artwork_8_image_path is configured in the emulator ini, links to an empty folder | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art9.png|thumb|''n64-art9.png'']] | ||
+ | ''' Artwork 9 '''<br /> | ||
+ | * Artwork 9 is a static empty image | ||
+ | * Artwork 9 is the emulator logo | ||
+ | * artwork_9_image_path is configured in the emulator ini, links to an empty folder | ||
+ | |- | ||
+ | |[[File:Layout_Editor-Layering_&_Transparency-N64-art10.png|thumb|''n64-art10.png'']] | ||
+ | ''' Artwork 10 '''<br /> | ||
+ | * Artwork 10 is a static empty image | ||
+ | * Artwork 10 is the "PRESS START" overlay | ||
+ | * artwork_10_image_path is configured in the emulator ini, links to an empty folder | ||
+ | |} | ||
− | === | + | === INI File Configuration === |
− | + | <pre> | |
− | + | ### Artwork Locations ### | |
+ | artwork_1_image_path ~/emulators/n64/artwork1 | ||
+ | artwork_2_image_path ~/emulators/n64/artwork2 | ||
+ | artwork_3_image_path ~/emulators/n64/artwork3 | ||
+ | artwork_4_image_path ~/emulators/n64/artwork4 | ||
+ | artwork_5_image_path ~/emulators/n64/artwork5 | ||
+ | artwork_6_image_path ~/emulators/n64/artwork6 | ||
+ | artwork_7_image_path ~/emulators/n64/artwork7 | ||
+ | artwork_8_image_path ~/emulators/n64/artwork8 | ||
+ | artwork_9_image_path ~/emulators/n64/artwork9 | ||
+ | artwork_10_image_path ~/emulators/n64/artwork10 | ||
+ | movie_preview_path | ||
+ | movie_artwork_no 1 | ||
+ | </pre> | ||
− | + | === Preview === | |
− | + | [[File:Layout Editor-Layering & Transparency-N64-preview.png|thumb|''Completed Layout'']] | |
− | + | The final layout, once it is put together on-screen by Wah!Cade | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | [[File: | ||
− | '' | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[Category:Layout]] | [[Category:Layout]] |
Latest revision as of 02:00, 25 April 2011
Introduction
The layout system in Wah!Cade constructs the screen using artwork as layers. These layers support transparency. Transparency must enabled in the item properties dialog when editing the item using the Layout Editor. We can take advantage of the way the screen is constructed to assist with generating complex composited layouts.
By default the layout system supports 3 major types of graphics. Each of these are used when building composited layouts in order of preference.
- Empty Artwork 1-10 (Static artwork displayed when no artwork is found)
- Artwork 1-10
- Background Images
Artwork Types
Empty Artwork
The Empty Artwork feature in Wah!Cade displays a "Game Not Found" image. When using composited layouts you will take advantage of this feature to load graphics as layers throughout your layout. Empty Artwork graphics can be used in any of the Artwork 1-10 items. These items support transparency, as do PNG and GIF images. Combining these artwork widgets with graphic files is how we will construct layered layouts.
The LAYOUT_EDITOR Documentation details the naming conventions available.
Using Empty Artwork as part of your layout will limit the number of dynamic Artwork items available once the base layout is built. This will need to be a consideration when planning a layout.
When using Empty Artwork items in your layout you will to add all the required Artwork items in the Layout Editor.
You can customise the layout on the fly if you have used Empty Artwork by adding images using a game name in the artwork directory used by the layout.
Artwork 1-10
Artwork items is the only method available for displaying dynamic artwork in a layout.
Background Images
Background images are static images, these items do not support transparency and are therefore limited in their application.
N64 Layout Example
Information
In this N64 Layout example there is no background image file used for the layout. The layout is built completely from artworks 1 through 10. The static layout is built from empty artwork files as mentioned previously. To make use of the empty artwork we intentionally break the artwork path for the artwork item. As a consideration, the intentional break is actually linked to an empty folder to allow for customisation in the future.
All 10 layers of this layout are customisable. For example you may choose to change (based on the item selected)
- The characters displayed on screen (Artwork 8)
- The colour of the main background (Artwork 4)
- The main background to a game background (Artwork 4)
- The console & controller images (Artwork 6)
- The console & controller images to a controller configuration information graphic (Artwork 6)
- The overlay used for the snap and title images (Artwork 3)
- The emulator logo (Artwork 9)
Breaking Down The Layers
Artwork 1
|
Artwork 2
|
Artwork 3
|
Artwork 4
|
Artwork 5
|
Artwork 6
|
Artwork 7
|
Artwork 8
|
Artwork 9
|
Artwork 10
|
INI File Configuration
### Artwork Locations ### artwork_1_image_path ~/emulators/n64/artwork1 artwork_2_image_path ~/emulators/n64/artwork2 artwork_3_image_path ~/emulators/n64/artwork3 artwork_4_image_path ~/emulators/n64/artwork4 artwork_5_image_path ~/emulators/n64/artwork5 artwork_6_image_path ~/emulators/n64/artwork6 artwork_7_image_path ~/emulators/n64/artwork7 artwork_8_image_path ~/emulators/n64/artwork8 artwork_9_image_path ~/emulators/n64/artwork9 artwork_10_image_path ~/emulators/n64/artwork10 movie_preview_path movie_artwork_no 1
Preview
The final layout, once it is put together on-screen by Wah!Cade