obs-StreamFX/source/gs-texture.h
Michael Fabian 'Xaymar' Dirks 2adfa5765c gs: Rename to snake_case instead of PascalCase
This should prevent mishaps with upper/lowercase typos and fits in better with the C++ standard code, which is also in snake_case.
2018-03-20 12:44:02 +01:00

155 lines
3.3 KiB
C++

/*
* Modern effects for a modern Streamer
* Copyright (C) 2017 Michael Fabian Dirks
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#pragma once
#include <inttypes.h>
#include <string>
extern "C" {
#pragma warning( push )
#pragma warning( disable: 4201 )
#include <libobs/graphics/graphics.h>
#pragma warning( pop )
}
namespace gs {
class texture {
protected:
gs_texture_t * m_texture;
bool m_isOwner = true;
public:
enum type : uint8_t {
Normal,
Volume,
Cube
};
enum flags : uint32_t {
Dynamic,
BuildMipMaps,
};
public:
/*!
* \brief Create a new texture from data
*
*
*
* \param width
* \param height
* \param format
* \param mip_levels
* \param mip_data
* \param flags
*/
texture(uint32_t width, uint32_t height, gs_color_format format, uint32_t mip_levels,
const uint8_t **mip_data, uint32_t flags);
/*!
* \brief Create a new volume texture from data
*
*
*
* \param width
* \param height
* \param depth
* \param format
* \param mip_levels
* \param mip_data
* \param flags
*/
texture(uint32_t width, uint32_t height, uint32_t depth, gs_color_format format, uint32_t mip_levels,
const uint8_t **mip_data, uint32_t flags);
/*!
* \brief Create a new cube texture from data
*
*
*
* \param size
* \param format
* \param mip_levels
* \param mip_data
* \param flags
*/
texture(uint32_t size, gs_color_format format, uint32_t mip_levels, const uint8_t **mip_data,
uint32_t flags);
/*!
* \brief Load a texture from a file
*
* Creates a new #GS::Texture from a file located on disk. If the
* file can not be found, accessed or read, a #Plugin::file_not_found_error
* will be thrown. If there is an error reading the file, a
* #Plugin::io_error will be thrown.
*
* \param file File to create the texture from.
*/
texture(std::string file);
/*!
* \brief Create a texture from an existing gs_texture_t object.
*/
texture(gs_texture_t* tex, bool takeOwnership = false) : m_texture(tex), m_isOwner(takeOwnership) {}
/*!
* \brief Copy an existing texture
*
* Create a Texture instance from an existing texture.
* This will not take ownership of the underlying gs_texture_t object.
*
* \param other
* \return
*/
texture(texture& other);
/*!
* \brief Default constructor
*/
texture() : m_texture(nullptr) {}
/*!
* \brief Destructor
*
*
*
* \return
*/
virtual ~texture();
/*!
* \brief
*
*
*
* \param unit
* \return void
*/
void load(int unit);
/*!
* \brief
*
*
*
* \return gs_texture_t*
*/
gs_texture_t* get_object();
};
}