.. Draft documentation master file, created by
   sphinx-quickstart on Tue Jul 15 13:34:37 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Draft |release| Documentation
=============================

Overview
--------

Draft is a lightweight compositing and video processing tool designed to automate typical post-render tasks. It is implemented as a Python library, which exposes functionality for use in python scripts. Draft is designed to be tightly integrated with Deadline, but it can also be used as a standalone tool.

Getting Started
---------------

.. toctree::
   :maxdepth: 1
   
   GettingStarted/InstallationAndLicensing
   GettingStarted/Usage

Concepts
--------

.. toctree::
   :maxdepth: 1

   Concepts/Image
   Concepts/ImageFileChannelMap
   Concepts/ImageInfo
   Concepts/Timecode
   Concepts/Video
   
.. _LibraryReference:
   
Library Reference
-----------------

.. toctree::
   :maxdepth: 2

   Anchor
   AnnotationInfo
   ColorRGBA
   CompositeOperator
   FontTypeMetric
   Image
   ImageInfo
   LibraryInfo
   LUT
   Timecode
   TileAssembler
   Video

.. _Cookbook:

Cookbook
-----------------

.. toctree::
   :maxdepth: 2

   Cookbook/Introduction

Basic Operations
~~~~~~~~~~~~~~~~

The basic operations cover the basics of Draft and what you will see in most Draft scripts. Things like creating an image and doing some simple text annotations are covered here, as well as how to setup a video encoder to create a video file.

.. toctree::
   :maxdepth: 1

   Cookbook/Basic/CreateAnImage
   Cookbook/Basic/CropAnImage
   Cookbook/Basic/CompositeTwoImages
   Cookbook/Basic/ConvertImageFormat
   Cookbook/Basic/CreateAnnotation
   Cookbook/Basic/ResizeAnImage
   Cookbook/Basic/CreateAQuickTimeMovie
   Cookbook/Basic/WriteAnImageWithFileChannelMap
   Cookbook/Basic/SetSavingSettingsInImageFile
   Cookbook/Basic/EmbedTimecodeInImageFile
   Cookbook/Basic/ConcatenateVideoFiles

Intermediate Operations
~~~~~~~~~~~~~~~~~~~~~~~

These operations are more involved but are typical things done with Draft such as working with Stereo footage and recipes for working with image sequences.

.. toctree::
   :maxdepth: 1

   Cookbook/Intermediate/CreateAnAnaglyphImage
   Cookbook/Intermediate/CreateAFrameCounter
   Cookbook/Intermediate/SplitMovieIntoSingleFrames
   Cookbook/Intermediate/CreateALeftEyeRightEyeSideBySideMovie
   Cookbook/Intermediate/SkippingMissingFramesInASequence
   Cookbook/Intermediate/CreateImageProxies
   Cookbook/Intermediate/SavingMulitpleVideosFromASingleInput
   Cookbook/Intermediate/ChangeTheEncodingOfVideo
   Cookbook/Intermediate/SettingTheCompressionQuality
   Cookbook/Intermediate/AddASlateFrameToAMovieClip
   Cookbook/Intermediate/UsingCustomParameters
   Cookbook/Intermediate/WriteAnImageWithMaxBitDepth
   Cookbook/Intermediate/EmbedTimecodeInVideoFile
   Cookbook/Intermediate/DisplayAnImageUsingPySide

Advanced Operations
~~~~~~~~~~~~~~~~~~~

These operations target an audience that is already comfortable with writing Draft scripts.

.. toctree::
   :maxdepth: 1

   Cookbook/Advanced/ExtractEXRLayersToImages

Deadline Integration
~~~~~~~~~~~~~~~~~~~~

The Deadline section focusses specifically on how to connect your Draft scripts to Deadline and how to take advantage of things like custom parameters and Deadline Job meta-data.

.. toctree::
   :maxdepth: 1

   Cookbook/DeadlineIntegration/ConvertAFrameStringToFrameList
   Cookbook/DeadlineIntegration/SubstitutingFramePaddingForAFrameNumber
   Cookbook/DeadlineIntegration/SettingUpCustomCommandLineParameters
   Cookbook/DeadlineIntegration/UsingDeadlineJobValues
   Cookbook/DeadlineIntegration/ParsingFileNamesToExtrachShotInformation

Color Operations
~~~~~~~~~~~~~~~~

This section focuses on color management within Draft and how to manipulate color spaces.

.. toctree::
   :maxdepth: 1

   Cookbook/ColorOperations/ApplyAGammaCorrection
   Cookbook/ColorOperations/CreateCineonImagesFromEXRImages
   Cookbook/ColorOperations/ConvertingColorSpaces
   Cookbook/ColorOperations/BakingAColorTransform

Release Notes
-------------

.. toctree::
   :maxdepth: 1

   ReleaseNotes/Draft1.5.3
   ReleaseNotes/Draft1.4.3
   ReleaseNotes/Draft1.3.2
   ReleaseNotes/Draft1.2.3
   ReleaseNotes/Draft1.1.1
   ReleaseNotes/Draft1.1.0

.. only:: html

    Indices and tables
    ------------------

    * :ref:`Concepts/ValidBitDepthReference`
    * :ref:`Concepts/ValidCompressionReference`
    * :ref:`Concepts/SupportedCodecReference`
    * :ref:`Concepts/ValidDNxHDSettingsReference`
    * :ref:`genindex`
    * :ref:`search`

