diff --git a/CMakeLists.txt b/CMakeLists.txt index 2a3db0f..75a705f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -34,3 +34,4 @@ add_definitions(-DPRECISION_DOUBLE) add_subdirectory(source) +add_subdirectory(docs) \ No newline at end of file diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 0000000..6fe171c --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,23 @@ + +find_package(Doxygen) + +if(NOT ${DOXYGEN_FOUND}) + message(STATUS "Doxygen is not found.") +endif() + +set(doc_api ${CMAKE_CURRENT_BINARY_DIR}/api/Doxyfile) + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/api/Doxyfile.in ${doc_api} @ONLY) + +add_custom_target( + documentation + COMMAND ${DOXYGEN_EXECUTABLE} ${doc_api} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api + COMMENT "Generating API documentation with Doxygen" + VERBATIM +) + +install( + DIRECTORY ${PROJECT_BINARY_DIR}/docs/api/html + DESTINATION share/doc/${CMAKE_PROJECT_NAME}/api +) \ No newline at end of file diff --git a/docs/api/Doxyfile.in b/docs/api/Doxyfile.in new file mode 100644 index 0000000..397d3d3 --- /dev/null +++ b/docs/api/Doxyfile.in @@ -0,0 +1,389 @@ +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = "@CMAKE_PROJECT_NAME@" +PROJECT_NUMBER = @PROJECT_VERSION@ +PROJECT_BRIEF = +PROJECT_LOGO = +OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/api +CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = # @PROJECT_SOURCE_DIR@/include @PROJECT_SOURCE_DIR@ +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +JAVADOC_BANNER = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +PYTHON_DOCSTRING = YES +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 4 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +OPTIMIZE_OUTPUT_SLICE = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +TOC_INCLUDE_HEADINGS = 5 +AUTOLINK_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO +TYPEDEF_HIDES_STRUCT = NO +LOOKUP_CACHE_SIZE = 0 +NUM_PROC_THREADS = 1 +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_PRIV_VIRTUAL = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +RESOLVE_UNNAMED_PARAMS = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = NO +HIDE_SCOPE_NAMES = NO +HIDE_COMPOUND_REFERENCE= NO +SHOW_HEADERFILE = YES +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_IF_INCOMPLETE_DOC = YES +WARN_NO_PARAMDOC = NO +WARN_AS_ERROR = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = @PROJECT_SOURCE_DIR@/source +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice \ + *.org +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +#USE_MDFILE_AS_MAINPAGE = +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = NO +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_INDEX_NUM_ENTRIES = 100 +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_FEEDURL = +DOCSET_BUNDLE_ID = org.doxygen.Project +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.doxygen.Project +DISABLE_INDEX = NO +GENERATE_TREEVIEW = YES +FULL_SIDEBAR = NO +ENUM_VALUES_PER_LINE = 4 +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +OBFUSCATE_EMAILS = YES +HTML_FORMULA_FORMAT = png +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +FORMULA_MACROFILE = +USE_MATHJAX = NO +MATHJAX_VERSION = MathJax_2 +MATHJAX_FORMAT = HTML-CSS +MATHJAX_RELPATH = +MATHJAX_EXTENSIONS = +MATHJAX_CODEFILE = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO +EXTERNAL_SEARCH = NO +SEARCHENGINE_URL = +SEARCHDATA_FILE = searchdata.xml +EXTERNAL_SEARCH_ID = +EXTRA_SEARCH_MAPPINGS = +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = +MAKEINDEX_CMD_NAME = makeindex +LATEX_MAKEINDEX_CMD = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4 +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_FILES = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_BIB_STYLE = plain +LATEX_TIMESTAMP = NO +LATEX_EMOJI_DIRECTORY = +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_SUBDIR = +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_PROGRAMLISTING = YES +XML_NS_MEMB_FILE_SCOPE = NO +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- +GENERATE_DOCBOOK = NO +DOCBOOK_OUTPUT = docbook +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +EXTERNAL_PAGES = YES +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +DIA_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +DOT_NUM_THREADS = 0 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +DOT_UML_DETAILS = NO +DOT_WRAP_THRESHOLD = 17 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DIR_GRAPH_MAX_DEPTH = 1 +DOT_IMAGE_FORMAT = png +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = +DIAFILE_DIRS = +PLANTUML_JAR_PATH = +PLANTUML_CFG_FILE = +PLANTUML_INCLUDE_PATH = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES diff --git a/source/hyporo/gpu/device.cpp b/source/hyporo/gpu/device.cpp index b483b72..684a1df 100644 --- a/source/hyporo/gpu/device.cpp +++ b/source/hyporo/gpu/device.cpp @@ -51,6 +51,39 @@ void Device::create(Device** device, DeviceAPI api) throw std::invalid_argument("Unsupported device"); } +// Render targets + +void Device::moveRenderTarget(RenderTarget* target, int x, int y) +{ + if (target == nullptr) + throw std::invalid_argument("Invalid parameter"); + target->p_posX = x; + target->p_posY = y; +} + +void Device::scaleRenderTarget(RenderTarget* target, int width, int height) +{ + if (target == nullptr) + throw std::invalid_argument("Invalid parameter"); + target->p_width = width; + target->p_height = height; +} + +void Device::destroyRenderTarget(RenderTarget*& target) +{ + if (!target) + throw std::runtime_error("Invalid parameter"); + + for (auto iter = p_renderTargets.begin(); iter != p_renderTargets.end(); ++iter) + if (*iter == target) + { + delete target; + target = nullptr; + p_renderTargets.remove(iter); + break; + } +} + // Buffers void Device::useVertexBuffer(Buffer* buffer, int stride, int offset) diff --git a/source/hyporo/gpu/device.hpp b/source/hyporo/gpu/device.hpp index ce51ad0..8d3ed59 100644 --- a/source/hyporo/gpu/device.hpp +++ b/source/hyporo/gpu/device.hpp @@ -9,6 +9,8 @@ #include "../hyplib/array/array.hpp" +#include "../window_system/window_system.hpp" + namespace hpr::gpu { @@ -38,6 +40,7 @@ protected: Buffer* p_currentUniformBuffer; ShaderProgram* p_currentShaderProgram; + darray p_renderTargets; protected: // Constructors @@ -70,6 +73,21 @@ public: virtual void faceCulling(bool enableFaceCulling, CullMode faceCullingMode) = 0; + // Render targets + + virtual + void createScreenRenderTarget(RenderTarget** target, Window* window) = 0; + virtual + void createFramebufferRenderTarget(RenderTarget** target, int width, int height) = 0; + virtual + void createSubRenderTarget(RenderTarget** target, RenderTarget* parent, int x, int y, int width, int height) = 0; + virtual + void moveRenderTarget(RenderTarget* target, int x, int y); + virtual + void scaleRenderTarget(RenderTarget* target, int width, int height); + virtual + void destroyRenderTarget(RenderTarget*& target); + // Buffers virtual diff --git a/source/hyporo/gpu/opengl/device.cpp b/source/hyporo/gpu/opengl/device.cpp index 0e0f11d..34f6829 100644 --- a/source/hyporo/gpu/opengl/device.cpp +++ b/source/hyporo/gpu/opengl/device.cpp @@ -71,6 +71,76 @@ void Device::faceCulling(bool enableFaceCulling, CullMode faceCullingMode) // Render targets +void Device::createScreenRenderTarget(gpu::RenderTarget** target, Window* window) +{ + if (target == nullptr) + throw std::invalid_argument("Invalid parameter"); + *target = nullptr; + p_renderTargets.push(new opengl::RenderTarget()); + auto* newTarget = dynamic_cast(p_renderTargets.back()); + + newTarget->p_type = RenderTarget::Type::Screen; + newTarget->p_posX = 0; + newTarget->p_posY = 0; + newTarget->p_width = window->width(); + newTarget->p_height = window->height(); + + *target = newTarget; +} + +void Device::createFramebufferRenderTarget(gpu::RenderTarget** target, int width, int height) +{ + if (target == nullptr) + throw std::invalid_argument("Invalid parameter"); + unsigned int texture; + glGenTextures(GL_TEXTURE_2D, &texture); + glBindTexture(GL_TEXTURE_2D, texture); + + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST); + + glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, nullptr); + + unsigned int framebuffer; + glGenFramebuffers(1, &framebuffer); + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, framebuffer); + + p_renderTargets.push(new opengl::RenderTarget()); + auto* newTarget = dynamic_cast(p_renderTargets.back()); + + newTarget->p_type = RenderTarget::Type::Framebuffer; + newTarget->p_posX = 0; + newTarget->p_posY = 0; + newTarget->p_width = width; + newTarget->p_height = height; + newTarget->p_frameBufferIndex = framebuffer; + newTarget->p_textureIndex = texture; + + *target = newTarget; +} + +void Device::createSubRenderTarget(gpu::RenderTarget** target, RenderTarget* parent, int x, int y, int width, int height) +{ + +} + +void Device::moveRenderTarget(gpu::RenderTarget* target, int x, int y) +{ + +} + +void Device::scaleRenderTarget(gpu::RenderTarget* target, int width, int height) +{ + +} + +void Device::destroyRenderTarget(gpu::RenderTarget*& target) +{ + +} + // Buffers diff --git a/source/hyporo/gpu/opengl/device.hpp b/source/hyporo/gpu/opengl/device.hpp index 6385004..f9abe35 100644 --- a/source/hyporo/gpu/opengl/device.hpp +++ b/source/hyporo/gpu/opengl/device.hpp @@ -40,8 +40,12 @@ public: // Render targets - virtual - void createScreenRenderTarget(RenderTarget** target); + void createScreenRenderTarget(RenderTarget** target, Window* window) override; + void createFramebufferRenderTarget(RenderTarget** target, int width, int height) override; + void createSubRenderTarget(RenderTarget** target, RenderTarget* parent, int x, int y, int width, int height) override; + void moveRenderTarget(RenderTarget* target, int x, int y) override; + void scaleRenderTarget(RenderTarget* target, int width, int height) override; + void destroyRenderTarget(RenderTarget*& target) override; // Buffers diff --git a/source/hyporo/window_system/window.hpp b/source/hyporo/window_system/window.hpp index 8c7e7b1..d52d2b0 100644 --- a/source/hyporo/window_system/window.hpp +++ b/source/hyporo/window_system/window.hpp @@ -81,9 +81,33 @@ public: virtual void size(int width, int height); + virtual + int width() const + { + return p_width; + } + + virtual + int height() const + { + return p_height; + } + virtual void position(int x, int y); + virtual + int posX() const + { + return p_posX; + } + + virtual + int posY() const + { + return p_posY; + } + virtual void title(const std::string& title);