User guide
19
are all nested in <formats> elements and take the form:
<format width="[int]" height="[int]" pixelAspect="[float]" name="[string]" groupName="
[string]"/>
You can edit existing resolutions, or add resolutions within the <format> tags, using the existing form.
Using a Custom Resolutions XML
You can use custom resolutions in an .xml file by placing it in a Resolutions sub-directory of any location specified
in your KATANA_RESOURCES environment variable. This adds the new resolutions specified in your .xml file to the
resolutions supplied with Katana.
You can also specify a KATANA_RESOLUTIONS environment variable, and point it to the location of a new resolutions
.xml file. This replaces the resolutions supplied with Katana with the contents of the new .xml file.
Using the Python API
To define new resolutions for use in a single Katana project (as with manual definitions specified through the UI),
start Katana in UI mode, and in the Python tab enter:
from Katana import ResolutionTable;
resolutionTable = ResolutionTable.GetResolutionTable();
r1 = resolutionTable.createResolution(1000, 1000, name="1K",
groupName="Thousands");
r2 = resolutionTable.createResolution(2000, 2000, name="2K",
groupName="Thousands");
r3 = resolutionTable.createResolution(3000, 3000, name="3K",
groupName="Thousands");
resolutionTable.addEntries([r1, r2, r3]);
TIP: Using Python to set the render resolution means you can make that resolution conditional on data
read from the Node Graph.
The createResolution() function takes in two ints, to specify width and height in pixels, and two strings to specify a
name, and group name. It creates a new resolution with the given width, height and name, and makes it available in
the specified group.
Resolutions entered this way expire with the Katana session. Using the ResolutionTable Python API, you can use
createResolutions() in Python startup scripts, making them persistent across Katana sessions. To do this, add the
code above —or your variant of it— to one of Katana's startup scripts. These are files named init.py, located in a
3 CUSTOM RENDER RESOLUTIONS | USING A CUSTOM RESOLUTIONS XML