APG Mapper Tutorial

How to Use the Advance Pixel Grid Mapper - Help & Tutorial

Introduction

The Advance Pixel Grid Mapper is a tool designed for easily laying out LED screens (panels) and exporting the configuration for Resolume Arena. Using this tool, you can create "Slices," apply "Masks," organize them under different "Screens," and map their input using "Composition Layers."

Core Concepts

Canvas

The black area where you draw. This represents your entire composition in Resolume.

Panel / Grid

The small boxes on the canvas. Each one represents an LED panel with the dimensions you define.

Slice

The primary shapes you create on the grid. Each "slice" corresponds to a layer in Resolume's Advanced Output.

Screen

A virtual output destination in Resolume. You can have multiple screens with different resolutions and output types (Virtual, NDI, Spout, Display). Slices must be placed under a screen.

Mask

A shape used to cover, crop, or alter the appearance of a Slice.

Composition Layer

Layers within Resolume's composition that can serve as a video signal source for your slices.

Step-by-Step User Guide

Step 1: Setting Up the Canvas

You now have two modes for setting up your canvas, which you can select under Canvas & Grid Settings:

  • Default Mode: For simple layouts using only one type of LED panel.
  • Advanced Mode: For complex layouts using multiple types of LED panels with different sizes.

Mode 1: Default Grid (Simple Setups)

  1. Select Grid Display: Make sure the Default radio button is selected.
  2. Panel Size (W x H): Enter the resolution of your single LED panel type (e.g., 128x128). The Panel Width and Panel Height controls will be enabled.
  3. Canvas Size (W x H): Enter the total combined resolution of all your LED panels (e.g., 2560x896).
  4. Resolution (W x H): This is the default resolution for new "Screens" you create.
  5. Generate New Grid: After entering the dimensions, click this button to create your uniform grid. Warning: This will erase your current work.

Mode 2: Advanced Grid (Multi-Panel Setups)

This mode is a premium feature required for complex stage designs with different panel models.

  1. Select Grid Display: Click the Advanced radio button. This will disable the main Panel Size inputs and enable the Multi-Panel Setup button and Snap Grid control.
  2. Open the Calculator: Click the Multi-Panel Setup button to open the "Canvas Size Calculator & Panel Setup" window.
  3. Define Your Panel Types:
    • Inside the calculator, click Add Panel Type to add a new row. Each row represents a group of identical panels in your layout.
    • Fill out the details for each row:
      • Panel Name: A descriptive name (e.g., "Main Wall P3", "DJ Booth P5").
      • Width/Height: The pixel resolution of a single panel in this group (e.g., 128 x 128).
      • # Across/# Down: How many of these panels are arranged horizontally and vertically in this specific group (e.g., 20 across, 7 down).
      • Col/Row: The position of this entire group in the "master grid." Use this to place panel groups above, below, or beside each other.
  4. Understanding Col and Row: The Col (Column) and Row numbers are the most powerful feature of the calculator. They allow you to define a "master layout grid." Think of your entire stage design as a big grid, and each panel group occupies one or more cells in that grid.
    • Example Scenario: Imagine a stage with a top LED banner, a main screen split into three sections (Left, Center, Right), and a bottom banner.
      • The Top Banner would be Row 1, Col 1.
      • The Left Screen would be Row 2, Col 1.
      • The Center Screen would be Row 2, Col 2.
      • The Right Screen would be Row 2, Col 3.
      • The Bottom Banner would be Row 3, Col 1.
    • How it Works: The calculator groups all items with the same Row number together. The final height of that "master row" is determined by the tallest group within it. Then, it adds up the widths of each "master column" (Col 1, Col 2, Col 3) to get the total canvas width. This allows you to create complex, non-rectangular layouts with perfect alignment.
  5. Calculate and Apply:
    • Click Recalculate to see the total computed canvas size based on your layout.
    • Click Apply & OK to close the calculator and apply the settings to the main form.
  6. Panel Library: Your defined panel types will now appear in the Panel Library list on the main window.

Step 2: Creating "Slices"

  1. Select Drawing Mode: Under Drawing Tools, ensure the Slice radio button is selected.
  2. (For Advanced Mode Only) Select a Panel Type: Before drawing, click on the desired panel type from the Panel Library list. The slice you draw will be based on the dimensions of the selected panel type.
  3. Name the Slice: In the Slice Name textbox, enter a name. If left blank, it will be automatically named "Slice 1," "Slice 2," etc.
  4. Choose a Color:
    • Manual: Select a color from the Manual Color Selection palette.
    • Automatic: Automatically picks the next color in the sequence.
  5. Draw on the Canvas: Click and drag your mouse on the grid to create a rectangular shape. This is your slice.
  6. The newly created slice will appear in the Screen and Slice Layout tree view.

Step 3: Organizing "Screens"

  1. Add a Screen: Click the Add Screen button below the Screen and Slice Layout to create a new screen.
  2. Move a Slice: You can drag and drop a slice from one screen to another in the tree view.
  3. Change Screen Settings:
    • Click the Screen's name in the tree view.
    • In the Screen [Name] panel, you can change the Device (Virtual, NDI, Spout) and its Width/Height (resolution).
  4. Rename/Delete: Right-click on a screen's name to rename or delete it. The very first screen cannot be deleted.

Step 4: Creating a "Mask"

  1. Select a Slice: First, click the slice you want to apply a mask to in the Screen and Slice Layout tree view.
  2. Select Mask Mode: In Drawing Tools, switch the selection to Mask.
  3. Choose a Mask Tool:
    • In the Mask Shape panel, pick a tool (e.g., Circle, Square, Pencil).
    • For Shape Tools (Circle, Square, etc.): Simply click the tool. It will automatically create a mask that fits the entire slice.
    • For the GridOnly Tool: Click and drag the mouse inside the slice to select panels that will become part of the mask.
    • For the Pencil Tool: This is for freeform drawing. Click to place points (vertices). Right-click to cancel. Click the first point to close the shape.

Step 5: Editing a Mask

  1. Select the Mask: In the tree view, click the "Mask" node located under a slice.
  2. Choose an Editing Mode (Mask Editing Mode panel):
    • Transform: Allows you to change the position and size of the entire mask using the Slice Properties panel.
    • Edit Points: Allows you to edit each individual point (vertex) of a mask created with the Pencil tool.
  3. For Edit Points:
    • Click a point on the canvas to select it. The selected point will turn red.
    • Drag the point to move it.
    • You can also change its X/Y coordinates in the Selected Vertex panel.
    • Point Mode: Switch between Linear (straight lines) and Bezier (curves).

Step 6: Using Composition Layers

  1. Add a Layer: In the Composition Layers panel, click Add Layer to create a new Resolume composition layer.
  2. Assign a Slice: Drag a slice from the Screen and Slice Layout tree view and drop it onto a layer in the Composition Layers tree view.
  3. Assign an Input Source:
    • Click a slice in the Screen and Slice Layout.
    • In the Slice Properties panel, use the Input dropdown to select which Composition Layer will be the video source for that slice.
  4. Adjust Opacity: Select a layer in the Composition Layers tree view and use the Opacity Control slider to adjust its master opacity.

Step 7: Saving and Loading a Project

  • Use File > Save Project to save all your screens, slices, masks, and composition layers into a single .gproj file.
  • Use File > Load Project to open your work again.

Step 8: Exporting the Output

  • File > Export Advance Output > Export Advance Output: This generates the .xml file you need for Resolume's Advanced Output. It will also generate a PNG guide image for each screen with its respective resolution.
  • File > Export Advance Output > Export Composition: This generates an .avc file that you can load as a composition in Resolume.

Additional Tips and Features

Navigating the Canvas

  • Pointer Tool: The default tool for selecting, moving, and interacting with slices.
  • Pan (Hand Tool): Select the Hand Tool from the toolbar to click and drag the canvas.
  • Zoom: Use the mouse wheel to zoom in and out. The canvas will zoom towards your mouse cursor's position.
  • Pan (Mouse): Alternatively, click and drag the middle mouse button to pan.
  • Reset View: Click the Default View button to return to the default zoom and position.

Snap Grid (Advanced Mode Only)

  • When in Advanced Mode, you can set a pixel value in the Snap Grid box (e.g., 16).
  • When you draw or move slices, they will snap to this pixel grid instead of the panel grid. This is useful for precise, fine-grained adjustments.

Managing Slices

  • Moving on Canvas: With the Pointer Tool selected, you can click and drag any slice directly on the canvas to reposition it. The mask will move along with it.
  • Duplicating: Right-click a slice in the tree view and select Duplicate Slice to create an exact copy in the same screen.
  • Reordering: Right-click a slice and use Move Up or Move Down to change its layer order within a screen. This affects rendering order.
  • Quick Re-assignment: Right-click a slice and use the Assign to Screen menu to quickly move it to a different screen.

Advanced Opacity Control

The Opacity Control slider is context-sensitive and adjusts the transparency of the last selected item type.

  • Background Image: Click the Select BG button or import a new background to make it the target. The slider will now control the background's transparency.
  • Screen Output: Select any Screen in the Screen and Slice Layout tree view. The slider will control the final output opacity of that entire screen in Resolume.
  • Composition Layer: Select any layer in the Composition Layers tree view. The slider will control the master opacity of that layer in Resolume.

Quick Delete

  • Right-click on a slice on the canvas.
  • If the slice has a mask, you will be asked if you want to delete the mask.
  • If it has no mask, you will be asked if you want to delete the entire slice.

Context Menus

Right-click on items in the tree views (Screen and Slice Layout, Composition Layers) for additional options like Rename and Delete.

Registration

Some advanced features (like Masking, Advanced Mode, and certain Exports) require registration. Go to Help > Registration to activate the product.