InputLayout.h

/*     Copyright 2015-2018 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
 * 
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF ANY PROPRIETARY RIGHTS.
 *
 *  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


#include "BasicTypes.h"

namespace Diligent
{

static constexpr Uint32 iMaxLayoutElements = 16;

struct LayoutElement
{
    Uint32 InputIndex;

    Uint32 BufferSlot;

    Uint32 NumComponents;

    VALUE_TYPE ValueType;

    Bool IsNormalized;

    Uint32 RelativeOffset;

    enum FREQUENCY : Int32
    {
        FREQUENCY_UNDEFINED = 0,

        FREQUENCY_PER_VERTEX,

        FREQUENCY_PER_INSTANCE,

        FREQUENCY_NUM_FREQUENCIES
    }Frequency;
    
    Uint32 InstanceDataStepRate;

    LayoutElement(Uint32 _InputIndex = 0, 
                   Uint32 _BufferSlot = 0, 
                   Uint32 _NumComponents = 0, 
                   VALUE_TYPE _ValueType = VT_FLOAT32,
                   Bool _IsNormalized = True, 
                   Uint32 _RelativeOffset = 0, 
                   FREQUENCY _Frequency = FREQUENCY_PER_VERTEX,
                   Uint32 _InstanceDataStepRate = 1) : 
        InputIndex(_InputIndex),
        BufferSlot(_BufferSlot),
        NumComponents(_NumComponents),
        ValueType(_ValueType),
        IsNormalized(_IsNormalized),
        RelativeOffset(_RelativeOffset),
        Frequency(_Frequency),
        InstanceDataStepRate(_InstanceDataStepRate)
    {}
};


struct InputLayoutDesc 
{
    const LayoutElement *LayoutElements;
    Uint32 NumElements;
    InputLayoutDesc() : 
        LayoutElements(nullptr),
        NumElements(0)
    {}
};

}