extComputationSchema.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
/* ************************************************************************** */
/* **                                                                      ** */
/* ** This file is generated by a script.                                  ** */
/* **                                                                      ** */
/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
/* ** Edit hdSchemaDefs.py instead to make changes.                        ** */
/* **                                                                      ** */
/* ************************************************************************** */
 
#ifndef PXR_IMAGING_HD_EXT_COMPUTATION_SCHEMA_H
#define PXR_IMAGING_HD_EXT_COMPUTATION_SCHEMA_H
 
 
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/schemaTypeDefs.h"
 
#include "pxr/imaging/hd/schema.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
 
using HdExtComputationCpuCallbackSharedPtr =
    std::shared_ptr<class HdExtComputationCpuCallback>;
using HdExtComputationCpuCallbackDataSource =
    HdTypedSampledDataSource<HdExtComputationCpuCallbackSharedPtr>;
using HdExtComputationCpuCallbackDataSourceHandle =
    HdExtComputationCpuCallbackDataSource::Handle;
 
// --(END CUSTOM CODE: Declares)--
 
#define HD_EXT_COMPUTATION_SCHEMA_TOKENS \
    (extComputation) \
    (inputValues) \
    (inputComputations) \
    (outputs) \
    (glslKernel) \
    (cpuCallback) \
    (dispatchCount) \
    (elementCount) \
 
TF_DECLARE_PUBLIC_TOKENS(HdExtComputationSchemaTokens, HD_API,
    HD_EXT_COMPUTATION_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
 
class HdExtComputationSchema : public HdSchema
{
public:
 
    HdExtComputationSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdExtComputationSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdSampledDataSourceContainerSchema GetInputValues() const;
 
    HD_API
    HdExtComputationInputComputationContainerSchema GetInputComputations() const;
 
    HD_API
    HdExtComputationOutputContainerSchema GetOutputs() const;
 
    HD_API
    HdStringDataSourceHandle GetGlslKernel() const;
 
    HD_API
    HdExtComputationCpuCallbackDataSourceHandle GetCpuCallback() const;
 
    HD_API
    HdSizetDataSourceHandle GetDispatchCount() const;
 
    HD_API
    HdSizetDataSourceHandle GetElementCount() const; 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HD_API
    static const HdDataSourceLocator &GetInputValuesLocator();
 
    HD_API
    static const HdDataSourceLocator &GetInputComputationsLocator();
 
    HD_API
    static const HdDataSourceLocator &GetOutputsLocator();
 
    HD_API
    static const HdDataSourceLocator &GetGlslKernelLocator();
 
    HD_API
    static const HdDataSourceLocator &GetCpuCallbackLocator();
 
    HD_API
    static const HdDataSourceLocator &GetDispatchCountLocator();
 
    HD_API
    static const HdDataSourceLocator &GetElementCountLocator();
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdContainerDataSourceHandle &inputValues,
        const HdContainerDataSourceHandle &inputComputations,
        const HdContainerDataSourceHandle &outputs,
        const HdStringDataSourceHandle &glslKernel,
        const HdExtComputationCpuCallbackDataSourceHandle &cpuCallback,
        const HdSizetDataSourceHandle &dispatchCount,
        const HdSizetDataSourceHandle &elementCount
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetInputValues(
            const HdContainerDataSourceHandle &inputValues);
        HD_API
        Builder &SetInputComputations(
            const HdContainerDataSourceHandle &inputComputations);
        HD_API
        Builder &SetOutputs(
            const HdContainerDataSourceHandle &outputs);
        HD_API
        Builder &SetGlslKernel(
            const HdStringDataSourceHandle &glslKernel);
        HD_API
        Builder &SetCpuCallback(
            const HdExtComputationCpuCallbackDataSourceHandle &cpuCallback);
        HD_API
        Builder &SetDispatchCount(
            const HdSizetDataSourceHandle &dispatchCount);
        HD_API
        Builder &SetElementCount(
            const HdSizetDataSourceHandle &elementCount);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdContainerDataSourceHandle _inputValues;
        HdContainerDataSourceHandle _inputComputations;
        HdContainerDataSourceHandle _outputs;
        HdStringDataSourceHandle _glslKernel;
        HdExtComputationCpuCallbackDataSourceHandle _cpuCallback;
        HdSizetDataSourceHandle _dispatchCount;
        HdSizetDataSourceHandle _elementCount;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif