libcruft-vk/object.hpp

94 lines
2.5 KiB
C++
Raw Normal View History

2016-02-26 13:39:01 +11:00
/*
* 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.
*
* Copyright:
2017-09-01 12:33:41 +10:00
* 2016-2017, Danny Robson <danny@nerdcruft.net>
2016-02-26 13:39:01 +11:00
*/
#ifndef CRUFT_VK_OBJECT_HPP
#define CRUFT_VK_OBJECT_HPP
2016-02-24 11:11:41 +11:00
#include "./traits.hpp"
#include "./except.hpp"
#include <utility>
#include <vector>
2016-02-24 11:11:41 +11:00
namespace cruft::vk {
2017-09-01 12:33:41 +10:00
/// the base class for all non-trivial vulkan objects requiring lifetime
/// management.
2016-02-24 11:11:41 +11:00
template <typename T>
struct object {
using id_t = typename id_traits<T>::id_t;
object (id_t);
object (object&&);
object (const object&) = delete;
2016-02-24 11:11:41 +11:00
const id_t& id (void) const&;
id_t& id (void) &;
2016-02-24 11:11:41 +11:00
private:
id_t m_id;
};
2017-09-01 12:33:41 +10:00
/// a vulkan object that must be directly instantiated through
/// constructor arguments, rather than being enumerated and owned by
/// another object.
2016-02-24 11:11:41 +11:00
template <typename T>
struct instantiated : public object<T> {
using id_t = typename object<T>::id_t;
template <typename ...Args>
instantiated (Args &&...args):
object<T> (make (std::forward<Args> (args)...))
{ ; }
~instantiated ()
{
life_traits<T>::destroy (this->id (), nullptr);
}
private:
template <typename ...Args>
static
id_t make (Args &&...args)
{
id_t id;
auto res = life_traits<T>::create (std::forward<Args> (args)..., &id);
error::try_code (res);
return id;
}
};
2017-09-01 12:33:41 +10:00
/// a vulkan object that is obtained by listings from a parent object.
2016-02-24 11:11:41 +11:00
template <typename T>
struct enumerated : public object<T> {
using object<T>::object;
static std::vector<T> find (const instance&);
};
2016-02-24 11:11:41 +11:00
2017-09-01 12:33:41 +10:00
/// a vulkan object that is directly owned by a parent object.
///
/// typically implies that this object must be freed using a reference to
/// the parent object.
2016-02-24 11:11:41 +11:00
template <typename T, typename O>
struct owned : public object<T> { };
}
#endif