InputLayout.h

Go to the documentation of this file.

/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */
 
#pragma once
 
// clang-format off
 
 
#include <string.h>
 
#include "GraphicsTypes.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
 
static const Uint32 MAX_LAYOUT_ELEMENTS        = 16;
static const Uint32 LAYOUT_ELEMENT_AUTO_OFFSET = 0xFFFFFFFF;
static const Uint32 LAYOUT_ELEMENT_AUTO_STRIDE = 0xFFFFFFFF;
 
enum INPUT_ELEMENT_FREQUENCY
{
    INPUT_ELEMENT_FREQUENCY_UNDEFINED = 0,
 
    INPUT_ELEMENT_FREQUENCY_PER_VERTEX,
 
    INPUT_ELEMENT_FREQUENCY_PER_INSTANCE,
 
    INPUT_ELEMENT_FREQUENCY_NUM_FREQUENCIES
};
 
struct LayoutElement
{
    const char* HLSLSemantic DEFAULT_INITIALIZER("ATTRIB");
 
    Uint32 InputIndex        DEFAULT_INITIALIZER(0);
 
    Uint32 BufferSlot        DEFAULT_INITIALIZER(0);
 
    Uint32 NumComponents     DEFAULT_INITIALIZER(0);
 
    VALUE_TYPE ValueType     DEFAULT_INITIALIZER(VT_FLOAT32);
 
    Bool IsNormalized        DEFAULT_INITIALIZER(True);
 
    Uint32 RelativeOffset    DEFAULT_INITIALIZER(LAYOUT_ELEMENT_AUTO_OFFSET);
 
    Uint32 Stride            DEFAULT_INITIALIZER(LAYOUT_ELEMENT_AUTO_STRIDE);
 
    enum INPUT_ELEMENT_FREQUENCY Frequency DEFAULT_INITIALIZER(INPUT_ELEMENT_FREQUENCY_PER_VERTEX);
    
    Uint32 InstanceDataStepRate DEFAULT_INITIALIZER(1);
 
 
#if DILIGENT_CPP_INTERFACE
 
    LayoutElement()noexcept{}
 
    LayoutElement(Uint32                   _InputIndex, 
                  Uint32                   _BufferSlot, 
                  Uint32                   _NumComponents, 
                  VALUE_TYPE               _ValueType,
                  Bool                     _IsNormalized         = LayoutElement{}.IsNormalized, 
                  Uint32                   _RelativeOffset       = LayoutElement{}.RelativeOffset,
                  Uint32                   _Stride               = LayoutElement{}.Stride,
                  INPUT_ELEMENT_FREQUENCY  _Frequency            = LayoutElement{}.Frequency,
                  Uint32                   _InstanceDataStepRate = LayoutElement{}.InstanceDataStepRate)noexcept : 
        InputIndex          {_InputIndex          },
        BufferSlot          {_BufferSlot          },
        NumComponents       {_NumComponents       },
        ValueType           {_ValueType           },
        IsNormalized        {_IsNormalized        },
        RelativeOffset      {_RelativeOffset      },
        Stride              {_Stride              },
        Frequency           {_Frequency           },
        InstanceDataStepRate{_InstanceDataStepRate}
    {}
 
    LayoutElement(const char*               _HLSLSemantic,
                  Uint32                    _InputIndex, 
                  Uint32                    _BufferSlot, 
                  Uint32                    _NumComponents, 
                  VALUE_TYPE                _ValueType,
                  Bool                      _IsNormalized         = LayoutElement{}.IsNormalized, 
                  Uint32                    _RelativeOffset       = LayoutElement{}.RelativeOffset,
                  Uint32                    _Stride               = LayoutElement{}.Stride,
                  INPUT_ELEMENT_FREQUENCY   _Frequency            = LayoutElement{}.Frequency,
                  Uint32                    _InstanceDataStepRate = LayoutElement{}.InstanceDataStepRate)noexcept :
        HLSLSemantic        {_HLSLSemantic        },
        InputIndex          {_InputIndex          },
        BufferSlot          {_BufferSlot          },
        NumComponents       {_NumComponents       },
        ValueType           {_ValueType           },
        IsNormalized        {_IsNormalized        },
        RelativeOffset      {_RelativeOffset      },
        Stride              {_Stride              },
        Frequency           {_Frequency           },
        InstanceDataStepRate{_InstanceDataStepRate}
    {}
 
    LayoutElement(Uint32                   _InputIndex, 
                  Uint32                   _BufferSlot, 
                  Uint32                   _NumComponents, 
                  VALUE_TYPE               _ValueType,
                  Bool                     _IsNormalized, 
                  INPUT_ELEMENT_FREQUENCY  _Frequency,
                  Uint32                   _InstanceDataStepRate = LayoutElement{}.InstanceDataStepRate)noexcept :
        InputIndex          {_InputIndex                   },
        BufferSlot          {_BufferSlot                   },
        NumComponents       {_NumComponents                },
        ValueType           {_ValueType                    },
        IsNormalized        {_IsNormalized                 },
        RelativeOffset      {LayoutElement{}.RelativeOffset},
        Stride              {LayoutElement{}.Stride        },
        Frequency           {_Frequency                    },
        InstanceDataStepRate{_InstanceDataStepRate         }
    {}
 
    bool operator == (const LayoutElement& rhs) const
    {
        return strcmp(HLSLSemantic, rhs.HLSLSemantic) == 0 &&
               InputIndex           == rhs.InputIndex      &&
               BufferSlot           == rhs.BufferSlot      &&
               NumComponents        == rhs.NumComponents   &&
               ValueType            == rhs.ValueType       &&
               IsNormalized         == rhs.IsNormalized    &&
               RelativeOffset       == rhs.RelativeOffset  &&
               Stride               == rhs.Stride          &&
               Frequency            == rhs.Frequency       &&
               InstanceDataStepRate == rhs.InstanceDataStepRate;
    }
 
    bool operator != (const LayoutElement& rhs) const
    {
        return !(*this == rhs);
    }
#endif
};
typedef struct LayoutElement LayoutElement;
 
 
 
struct InputLayoutDesc
{
    const LayoutElement* LayoutElements  DEFAULT_INITIALIZER(nullptr);
    Uint32               NumElements     DEFAULT_INITIALIZER(0);
 
#if DILIGENT_CPP_INTERFACE
    InputLayoutDesc()noexcept{}
 
    InputLayoutDesc(const LayoutElement* _LayoutElements, 
                    Uint32               _NumElements)noexcept :
        LayoutElements{_LayoutElements},
        NumElements   {_NumElements   }
    {}
 
    bool operator == (const InputLayoutDesc& rhs) const
    {
        if (NumElements != rhs.NumElements)
            return false;
 
        for (Uint32 i=0; i < NumElements; ++i)
        {
            if (LayoutElements[i] != rhs.LayoutElements[i])
                return false;
        }
 
        return true;
    }
 
    bool operator != (const InputLayoutDesc& rhs) const
    {
        return !(*this == rhs);
    }
#endif
};
typedef struct InputLayoutDesc InputLayoutDesc;
 
DILIGENT_END_NAMESPACE