renderBufferSchema.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_RENDER_BUFFER_SCHEMA_H
#define PXR_IMAGING_HD_RENDER_BUFFER_SCHEMA_H
 
 
#include "pxr/imaging/hd/api.h"
 
#include "pxr/imaging/hd/schema.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
// --(END CUSTOM CODE: Declares)--
 
#define HD_RENDER_BUFFER_SCHEMA_TOKENS \
    (renderBuffer) \
    (dimensions) \
    (format) \
    (multiSampled) \
 
TF_DECLARE_PUBLIC_TOKENS(HdRenderBufferSchemaTokens, HD_API,
    HD_RENDER_BUFFER_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
 
class HdRenderBufferSchema : public HdSchema
{
public:
 
    HdRenderBufferSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdRenderBufferSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdVec3iDataSourceHandle GetDimensions() const;
 
    HD_API
    HdFormatDataSourceHandle GetFormat() const;
 
    HD_API
    HdBoolDataSourceHandle GetMultiSampled() const; 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HD_API
    static const HdDataSourceLocator &GetDimensionsLocator();
 
    HD_API
    static const HdDataSourceLocator &GetFormatLocator();
 
    HD_API
    static const HdDataSourceLocator &GetMultiSampledLocator();
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdVec3iDataSourceHandle &dimensions,
        const HdFormatDataSourceHandle &format,
        const HdBoolDataSourceHandle &multiSampled
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetDimensions(
            const HdVec3iDataSourceHandle &dimensions);
        HD_API
        Builder &SetFormat(
            const HdFormatDataSourceHandle &format);
        HD_API
        Builder &SetMultiSampled(
            const HdBoolDataSourceHandle &multiSampled);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdVec3iDataSourceHandle _dimensions;
        HdFormatDataSourceHandle _format;
        HdBoolDataSourceHandle _multiSampled;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif