spec.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_USD_RENDER_SPEC_H
#define PXR_USD_USD_RENDER_SPEC_H


#include "pxr/pxr.h"
#include "pxr/usd/usdRender/api.h"
#include "pxr/usd/usdRender/settingsBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdRender/tokens.h"

#include "pxr/base/gf/frustum.h"

#include "pxr/base/vt/dictionary.h"
#include "pxr/base/vt/value.h"

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"

#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

PXR_NAMESPACE_OPEN_SCOPE

class UsdRenderSettings;

struct UsdRenderSpec {
    struct Product {
        SdfPath renderProductPath;
        TfToken type;
        TfToken name;
        SdfPath cameraPath;
        bool disableMotionBlur;
        GfVec2i resolution;
        float pixelAspectRatio;
        TfToken aspectRatioConformPolicy;
        GfVec2f apertureSize;
        GfRange2f dataWindowNDC;
        std::vector<size_t> renderVarIndices;
        VtDictionary namespacedSettings;
    };
    struct RenderVar {
        SdfPath renderVarPath;
        TfToken dataType;
        std::string sourceName;
        TfToken sourceType;
        VtDictionary namespacedSettings;
    };
    std::vector<Product> products;
    std::vector<RenderVar> renderVars;
    VtArray<TfToken> includedPurposes;
    VtArray<TfToken> materialBindingPurposes;
    VtDictionary namespacedSettings;
};

USDRENDER_API
UsdRenderSpec
UsdRenderComputeSpec(UsdRenderSettings const& settings,
                     TfTokenVector const& namespaces);

USDRENDER_API
VtDictionary
UsdRenderComputeNamespacedSettings(UsdPrim const& prim,
                                   TfTokenVector const& namespaces);

PXR_NAMESPACE_CLOSE_SCOPE

#endif