Class ShaderVarOffset

Source/Falcor/Core/Program/ProgramReflection.h:359–504

* Represents the offset of a shader variable relative to its enclosing type/buffer/block. * * A `ShaderVarOffset` can be used to store the offset of a shader variable that might use * ordinary/uniform data, resources like textures/buffers/samplers, or some combination. * It effectively stores both a `UniformShaderVarOffset` and a `ResourceShaderVarOffset` * * A `ShaderVarOffset` can also enc

 *
 */
struct ShaderVarOffset
{
public:
    /**
     * Construct a shader variable offset from its underlying uniform and resource offsets.
     */
    ShaderVarOffset(UniformShaderVarOffset uniform, ResourceShaderVarOffset resource) : mUniform(uniform), mResource(resource) {}

    /**
     * Custom enumeration type used to represent an invalid offset.
     *
     * Can be used to initialize a `ShaderVarOffset` when an explicit invalid is desired:
     *
     * ShaderVarOffset myOffset = ShaderVarOffset::kInvalid;
     *
     * Note that the default constructor also constructs an invalid offset, so this
     * could be written more simply as:
     *
     * ShaderVarOffset myOffset;
     *
     */
    enum Invalid
    {
        kInvalid = -1
    };

    /**
     * Default constructor: constructs an invalid offset.
     */
    ShaderVarOffset(Invalid _ = kInvalid) : mUniform(UniformShaderVarOffset::kInvalid), mResource(ResourceShaderVarOffset::kInvalid) {}

    /**
     * Custom enumeration type used to represent a zero offset.
     *
     * Can be used to initialize a `ShaderVarOffset` when an explicit zero offset is desired:
     *
     * ShaderVarOffset myOffset = ShaderVarOffset::kZero;
     */
    enum Zero
    {
        kZero = 0
    };

    /**
     * Construct an explicit zero offset.
     */
    ShaderVarOffset(Zero) : mUniform(UniformShaderVarOffset::kZero), mResource(ResourceShaderVarOffset::kZero) {}

    /**
     * Check if this is a valid offset.
     */
    bool isValid() const { return mUniform.isValid(); }

    /**
     * Get the underlying uniform offset.
     */
    UniformShaderVarOffset getUniform() const { return mUniform; }