VULKAN_HPP_NAMESPACE::StructureChain< ChainElements > Class Template Reference

#include <vulkan.hpp>

Inheritance diagram for VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >:

Collaboration diagram for VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >:

Data Structures
struct	ChainElementIndex
struct	ChainElementIndex< Index, T, 0, typename std::enable_if< std::is_same< T, First >::value, void >::type, First, Types... >
struct	ChainElementIndex< Index, T, Which, typename std::enable_if< std::is_same< T, First >::value, void >::type, First, Types... >
struct	ChainElementIndex< Index, T, Which, typename std::enable_if<!std::is_same< T, First >::value, void >::type, First, Types... >

Public Member Functions
	StructureChain () VULKAN_HPP_NOEXCEPT
	StructureChain (StructureChain const &rhs) VULKAN_HPP_NOEXCEPT
	StructureChain (StructureChain &&rhs) VULKAN_HPP_NOEXCEPT
	StructureChain (ChainElements const &... elems) VULKAN_HPP_NOEXCEPT
StructureChain &	operator= (StructureChain const &rhs) VULKAN_HPP_NOEXCEPT
StructureChain &	operator= (StructureChain &&rhs)=delete
template<typename T , size_t Which = 0>
T &	get () VULKAN_HPP_NOEXCEPT
template<typename T , size_t Which = 0>
T const &	get () const VULKAN_HPP_NOEXCEPT
template<typename T0 , typename T1 , typename... Ts>
std::tuple< T0 &, T1 &, Ts &... >	get () VULKAN_HPP_NOEXCEPT
template<typename T0 , typename T1 , typename... Ts>
std::tuple< T0 const &, T1 const &, Ts const &... >	get () const VULKAN_HPP_NOEXCEPT
template<typename ClassType , size_t Which = 0>
void	relink () VULKAN_HPP_NOEXCEPT
template<typename ClassType , size_t Which = 0>
void	unlink () VULKAN_HPP_NOEXCEPT

Private Member Functions
bool	isLinked (VkBaseInStructure const *pNext)
template<size_t Index>
std::enable_if< Index !=0, void >::type	link () VULKAN_HPP_NOEXCEPT
template<size_t Index>
std::enable_if< Index==0, void >::type	link () VULKAN_HPP_NOEXCEPT
template<size_t Index>
std::enable_if< Index !=0, void >::type	unlink (VkBaseOutStructure const *pNext) VULKAN_HPP_NOEXCEPT
template<size_t Index>
std::enable_if< Index==0, void >::type	unlink (VkBaseOutStructure const *pNext) VULKAN_HPP_NOEXCEPT

Detailed Description

template<typename... ChainElements>
class VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >

Definition at line 913 of file vulkan.hpp.

Constructor & Destructor Documentation

StructureChain() [1/4]

template<typename... ChainElements>

VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::StructureChain ( )

inline

Definition at line 916 of file vulkan.hpp.

    {
      static_assert( StructureChainValidation<sizeof...( ChainElements ) - 1, ChainElements...>::valid,
                     "The structure chain is not valid!" );
      link<sizeof...( ChainElements ) - 1>();
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link().

StructureChain() [2/4]

template<typename... ChainElements>

VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::StructureChain ( StructureChain< ChainElements > const &  rhs )

inline

Definition at line 923 of file vulkan.hpp.

                                                                     : std::tuple<ChainElements...>( rhs )
    {
      static_assert( StructureChainValidation<sizeof...( ChainElements ) - 1, ChainElements...>::valid,
                     "The structure chain is not valid!" );
      link<sizeof...( ChainElements ) - 1>();
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link().

StructureChain() [3/4]

template<typename... ChainElements>

VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::StructureChain ( StructureChain< ChainElements > &&  rhs )

inline

Definition at line 930 of file vulkan.hpp.

      : std::tuple<ChainElements...>( std::forward<std::tuple<ChainElements...>>( rhs ) )
    {
      static_assert( StructureChainValidation<sizeof...( ChainElements ) - 1, ChainElements...>::valid,
                     "The structure chain is not valid!" );
      link<sizeof...( ChainElements ) - 1>();
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link().

StructureChain() [4/4]

template<typename... ChainElements>

VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::StructureChain ( ChainElements const &...  elems )

inline

Definition at line 938 of file vulkan.hpp.

                                                                         : std::tuple<ChainElements...>( elems... )
    {
      static_assert( StructureChainValidation<sizeof...( ChainElements ) - 1, ChainElements...>::valid,
                     "The structure chain is not valid!" );
      link<sizeof...( ChainElements ) - 1>();
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link().

Member Function Documentation

get() [1/4]

template<typename... ChainElements>

template<typename T , size_t Which = 0>

T const& VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::get ( ) const

inline

Definition at line 961 of file vulkan.hpp.

    {
      return std::get<ChainElementIndex<0, T, Which, void, ChainElements...>::value>( static_cast<std::tuple<ChainElements...>&>( *this ) );
    }

References T, and void.

get() [2/4]

template<typename... ChainElements>

template<typename T0 , typename T1 , typename... Ts>

std::tuple<T0 const &, T1 const &, Ts const &...> VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::get ( ) const

inline

Definition at line 973 of file vulkan.hpp.

    {
      return std::tie( get<T0>(), get<T1>(), get<Ts>()... );
    }

get() [3/4]

template<typename... ChainElements>

template<typename T , size_t Which = 0>

T& VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::get ( )

inline

Definition at line 955 of file vulkan.hpp.

    {
      return std::get<ChainElementIndex<0, T, Which, void, ChainElements...>::value>( static_cast<std::tuple<ChainElements...>&>( *this ) );
    }

References T, and void.

get() [4/4]

template<typename... ChainElements>

template<typename T0 , typename T1 , typename... Ts>

std::tuple<T0 &, T1 &, Ts &...> VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::get ( )

inline

Definition at line 967 of file vulkan.hpp.

    {
      return std::tie( get<T0>(), get<T1>(), get<Ts>()... );
    }

isLinked()

template<typename... ChainElements>

bool VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::isLinked ( VkBaseInStructure const *  pNext )

inlineprivate

Definition at line 1038 of file vulkan.hpp.

    {
      VkBaseInStructure const * elementPtr = reinterpret_cast<VkBaseInStructure const*>(&std::get<0>( static_cast<std::tuple<ChainElements...>&>( *this ) ) );
      while ( elementPtr )
      {
        if ( elementPtr->pNext == pNext )
        {
          return true;
        }
        elementPtr = elementPtr->pNext;
      }
      return false;
    }

References VkBaseInStructure::pNext.

Referenced by VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::relink().

link() [1/2]

template<typename... ChainElements>

template<size_t Index>

std::enable_if<Index != 0, void>::type VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link ( )

inlineprivate

Definition at line 1053 of file vulkan.hpp.

    {
      auto & x = std::get<Index - 1>( static_cast<std::tuple<ChainElements...>&>( *this ) );
      x.pNext  = &std::get<Index>( static_cast<std::tuple<ChainElements...>&>( *this ) );
      link<Index - 1>();
    }

Referenced by VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::operator=(), and VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::StructureChain().

link() [2/2]

template<typename... ChainElements>

template<size_t Index>

std::enable_if<Index == 0, void>::type VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link ( )

inlineprivate

Definition at line 1061 of file vulkan.hpp.

    {}

operator=() [1/2]

template<typename... ChainElements>

StructureChain& VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::operator= ( StructureChain< ChainElements > &&  rhs )

delete

operator=() [2/2]

template<typename... ChainElements>

StructureChain& VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::operator= ( StructureChain< ChainElements > const &  rhs )

inline

Definition at line 945 of file vulkan.hpp.

    {
      std::tuple<ChainElements...>::operator=( rhs );
      link<sizeof...( ChainElements ) - 1>();
      return *this;
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::link().

relink()

template<typename... ChainElements>

template<typename ClassType , size_t Which = 0>

void VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::relink ( )

inline

Definition at line 979 of file vulkan.hpp.

    {
      static_assert( IsPartOfStructureChain<ClassType, ChainElements...>::valid,
                     "Can't relink Structure that's not part of this StructureChain!" );
      static_assert(
        !std::is_same<ClassType, typename std::tuple_element<0, std::tuple<ChainElements...>>::type>::value || (Which != 0),
        "It's not allowed to have the first element unlinked!" );
 
      auto pNext = reinterpret_cast<VkBaseInStructure *>( &get<ClassType, Which>() );
      VULKAN_HPP_ASSERT( !isLinked( pNext ) );
      auto & headElement = std::get<0>( static_cast<std::tuple<ChainElements...>&>( *this ) );
      pNext->pNext       = reinterpret_cast<VkBaseInStructure const*>(headElement.pNext);
      headElement.pNext  = pNext;
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::isLinked(), VkBaseInStructure::pNext, and VULKAN_HPP_ASSERT.

unlink() [1/3]

template<typename... ChainElements>

template<typename ClassType , size_t Which = 0>

void VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::unlink ( )

inline

Definition at line 995 of file vulkan.hpp.

    {
      static_assert( IsPartOfStructureChain<ClassType, ChainElements...>::valid,
                     "Can't unlink Structure that's not part of this StructureChain!" );
      static_assert(
        !std::is_same<ClassType, typename std::tuple_element<0, std::tuple<ChainElements...>>::type>::value || (Which != 0),
        "It's not allowed to unlink the first element!" );
 
      unlink<sizeof...( ChainElements ) - 1>( reinterpret_cast<VkBaseOutStructure const *>( &get<ClassType, Which>() ) );
    }

Referenced by VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::unlink().

unlink() [2/3]

template<typename... ChainElements>

template<size_t Index>

std::enable_if<Index != 0, void>::type VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::unlink ( VkBaseOutStructure const *  pNext )

inlineprivate

Definition at line 1065 of file vulkan.hpp.

    {
      auto & element = std::get<Index>( static_cast<std::tuple<ChainElements...>&>( *this ) );
      if ( element.pNext == pNext )
      {
        element.pNext = pNext->pNext;
      }
      else
      {
        unlink<Index - 1>( pNext );
      }
    }

References VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::unlink().

unlink() [3/3]

template<typename... ChainElements>

template<size_t Index>

std::enable_if<Index == 0, void>::type VULKAN_HPP_NAMESPACE::StructureChain< ChainElements >::unlink ( VkBaseOutStructure const *  pNext )

inlineprivate

Definition at line 1079 of file vulkan.hpp.

    {
      auto & element = std::get<0>( static_cast<std::tuple<ChainElements...>&>( *this ) );
      if ( element.pNext == pNext )
      {
        element.pNext = pNext->pNext;
      }
      else
      {
        VULKAN_HPP_ASSERT( false );  // fires, if the ClassType member has already been unlinked !
      }
    }

References VULKAN_HPP_ASSERT.

---

The documentation for this class was generated from the following file:

• src/video/khronos/vulkan/vulkan.hpp