BufferView.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 "DeviceObject.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
// {E2E83490-E9D2-495B-9A83-ABB413A38B07}
static const struct INTERFACE_ID IID_BufferView =
    {0xe2e83490, 0xe9d2, 0x495b, {0x9a, 0x83, 0xab, 0xb4, 0x13, 0xa3, 0x8b, 0x7}};
 
struct BufferFormat
{
    VALUE_TYPE ValueType    DEFAULT_INITIALIZER(VT_UNDEFINED);
 
    Uint8 NumComponents     DEFAULT_INITIALIZER(0);
 
    Bool IsNormalized       DEFAULT_INITIALIZER(False);
 
 
#if DILIGENT_CPP_INTERFACE
    // We have to explicitly define constructors because otherwise Apple's clang fails to compile the following legitimate code:
    //     BufferFormat{VT_FLOAT32, 4}
    
    BufferFormat()noexcept{}
 
    BufferFormat(VALUE_TYPE _ValueType,
                 Uint8      _NumComponents,
                 Bool       _IsNormalized   = BufferFormat{}.IsNormalized)noexcept : 
        ValueType     {_ValueType    },
        NumComponents {_NumComponents},
        IsNormalized  {_IsNormalized }
    {}
 
 
    bool operator == (const BufferFormat& RHS)const
    {
        return ValueType     == RHS.ValueType && 
               NumComponents == RHS.NumComponents &&
               IsNormalized  == RHS.IsNormalized;
    }
#endif
};
typedef struct BufferFormat BufferFormat;
 
struct BufferViewDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    BUFFER_VIEW_TYPE ViewType DEFAULT_INITIALIZER(BUFFER_VIEW_UNDEFINED);
 
    struct BufferFormat Format;
 
    Uint32 ByteOffset       DEFAULT_INITIALIZER(0);
 
    Uint32 ByteWidth        DEFAULT_INITIALIZER(0);
 
 
#if DILIGENT_CPP_INTERFACE
    BufferViewDesc()noexcept{}
 
    explicit
    BufferViewDesc(BUFFER_VIEW_TYPE _ViewType,
                   BufferFormat     _Format     = BufferViewDesc{}.Format,
                   Uint32           _ByteOffset = BufferViewDesc{}.ByteOffset,
                   Uint32           _ByteWidth  = BufferViewDesc{}.ByteWidth)noexcept :
        ViewType    {_ViewType  },
        Format      {_Format    },
        ByteOffset  {_ByteOffset},
        ByteWidth   {_ByteWidth }
    {}
 
 
    bool operator==(const BufferViewDesc& RHS) const
    {
               // Name is primarily used for debug purposes and does not affect the view.
               // It is ignored in comparison operation.
        return //strcmp(Name, RHS.Name) == 0 &&
               ViewType  == RHS.ViewType   &&
               ByteOffset== RHS.ByteOffset &&
               ByteWidth == RHS.ByteWidth  &&
               Format    == RHS.Format;
    }
#endif
};
typedef struct BufferViewDesc BufferViewDesc;
 
#define DILIGENT_INTERFACE_NAME IBufferView
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IBufferViewInclusiveMethods \
    IDeviceObjectInclusiveMethods;  \
    IBufferViewMethods BufferView
 
 
DILIGENT_BEGIN_INTERFACE(IBufferView, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const BufferViewDesc& METHOD(GetDesc)() const override = 0;
#endif
 
 
    VIRTUAL struct IBuffer* METHOD(GetBuffer)(THIS) CONST PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format off
 
#    define IBufferView_GetDesc(This) (const struct BufferViewDesc*)IDeviceObject_GetDesc(This)
 
#    define IBufferView_GetBuffer(This) CALL_IFACE_METHOD(BufferView, GetBuffer, This)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent