From 64433315a1d8d6d8b05cf0cd083a44af67218846 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 20 Feb 2021 19:25:15 +0100 Subject: [PATCH] Doc++, updated credits and changelog. Also retroactively added relevant copyright headers to other apps. --- doc/changelog.dox | 5 +++++ src/Magnum/Platform/AbstractXApplication.cpp | 1 + src/Magnum/Platform/AbstractXApplication.h | 1 + src/Magnum/Platform/EmscriptenApplication.h | 2 +- src/Magnum/Platform/GlfwApplication.cpp | 3 ++- src/Magnum/Platform/GlfwApplication.h | 3 ++- src/Magnum/Platform/WindowlessCglApplication.cpp | 1 + src/Magnum/Platform/WindowlessCglApplication.h | 8 +++++++- src/Magnum/Platform/WindowlessEglApplication.cpp | 1 + src/Magnum/Platform/WindowlessEglApplication.h | 10 ++++++++-- src/Magnum/Platform/WindowlessGlxApplication.cpp | 1 + src/Magnum/Platform/WindowlessGlxApplication.h | 8 +++++++- 12 files changed, 37 insertions(+), 7 deletions(-) diff --git a/doc/changelog.dox b/doc/changelog.dox index 605f9df87..b3f557da9 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -108,6 +108,11 @@ See also: - It's now possible to have multiple @ref Platform::EmscriptenApplication canvases on a single page (see [mosra/magnum#480](https://github.com/mosra/magnum/pull/480), [mosra/magnum#481](https://github.com/mosra/magnum/pull/481)) +- Added @relativeref{Platform::WindowlessEglContext,release()} as a + counterpart to @relativeref{Platform::WindowlessEglContext,makeCurrent()} + to all @cpp Platform::Windowless*Context @ce classes. Useful for + transferring OpenGL contexts between threads, see also + [mosra/magnum#495](https://github.com/mosra/magnum/pull/495). @subsubsection changelog-latest-new-shaders Shaders library diff --git a/src/Magnum/Platform/AbstractXApplication.cpp b/src/Magnum/Platform/AbstractXApplication.cpp index ee5a01742..24b1e06c7 100644 --- a/src/Magnum/Platform/AbstractXApplication.cpp +++ b/src/Magnum/Platform/AbstractXApplication.cpp @@ -3,6 +3,7 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš + Copyright © 2019, 2020 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/src/Magnum/Platform/AbstractXApplication.h b/src/Magnum/Platform/AbstractXApplication.h index 9589be01f..e2745093f 100644 --- a/src/Magnum/Platform/AbstractXApplication.h +++ b/src/Magnum/Platform/AbstractXApplication.h @@ -5,6 +5,7 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš + Copyright © 2019, 2020 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/src/Magnum/Platform/EmscriptenApplication.h b/src/Magnum/Platform/EmscriptenApplication.h index e9d007083..3c7f2659c 100644 --- a/src/Magnum/Platform/EmscriptenApplication.h +++ b/src/Magnum/Platform/EmscriptenApplication.h @@ -5,7 +5,7 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš - Copyright © 2018, 2019 Jonathan Hale + Copyright © 2018, 2019, 2020 Jonathan Hale Copyright © 2020 Pablo Escobar Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/Magnum/Platform/GlfwApplication.cpp b/src/Magnum/Platform/GlfwApplication.cpp index 1952ed6d9..3115e49c2 100644 --- a/src/Magnum/Platform/GlfwApplication.cpp +++ b/src/Magnum/Platform/GlfwApplication.cpp @@ -3,7 +3,8 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš - Copyright © 2016 Jonathan Hale + Copyright © 2016, 2018 Jonathan Hale + Copyright © 2019 Konstantinos Chatzilygeroudis Copyright © 2019, 2020 Marco Melorio Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index e32d56f40..3706d7e5d 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -5,7 +5,8 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš - Copyright © 2016 Jonathan Hale + Copyright © 2016, 2018 Jonathan Hale + Copyright © 2019 Konstantinos Chatzilygeroudis Copyright © 2019, 2020 Marco Melorio Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/Magnum/Platform/WindowlessCglApplication.cpp b/src/Magnum/Platform/WindowlessCglApplication.cpp index c7e5b4819..9ac9395be 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.cpp +++ b/src/Magnum/Platform/WindowlessCglApplication.cpp @@ -5,6 +5,7 @@ 2020, 2021 Vladimír Vondruš Copyright © 2013 Copyright © 2014 Travis Watkins + Copyright © 2021 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/src/Magnum/Platform/WindowlessCglApplication.h b/src/Magnum/Platform/WindowlessCglApplication.h index a328c1081..271e0c70f 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.h +++ b/src/Magnum/Platform/WindowlessCglApplication.h @@ -7,6 +7,7 @@ 2020, 2021 Vladimír Vondruš Copyright © 2013 Copyright © 2014 Travis Watkins + Copyright © 2021 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), @@ -122,13 +123,18 @@ class WindowlessCglContext { * @brief Make the context current * * Prints error message and returns @cpp false @ce on failure, - * otherwise returns @cpp true @ce. + * otherwise returns @cpp true @ce. If the context is current on + * another thread, you have to @ref release() it there first --- an + * OpenGL context can't be current in multiple threads at the same + * time. */ bool makeCurrent(); /** * @brief Release current context + * @m_since_latest * + * Releases a context previously made current using @ref makeCurrent(). * Prints error message and returns @cpp false @ce on failure, * otherwise returns @cpp true @ce. */ diff --git a/src/Magnum/Platform/WindowlessEglApplication.cpp b/src/Magnum/Platform/WindowlessEglApplication.cpp index 668a5ef3c..6a6462e47 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.cpp +++ b/src/Magnum/Platform/WindowlessEglApplication.cpp @@ -4,6 +4,7 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš Copyright © 2020, 2021 Erik Wijmans + Copyright © 2021 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/src/Magnum/Platform/WindowlessEglApplication.h b/src/Magnum/Platform/WindowlessEglApplication.h index 7ac1cb0ca..b79479d5e 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.h +++ b/src/Magnum/Platform/WindowlessEglApplication.h @@ -5,7 +5,8 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš - Copyright © 2020 Erik Wijmans + Copyright © 2020, 2021 Erik Wijmans + Copyright © 2021 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), @@ -123,13 +124,18 @@ class WindowlessEglContext { * @brief Make the context current * * Prints error message and returns @cpp false @ce on failure, - * otherwise returns @cpp true @ce. + * otherwise returns @cpp true @ce. If the context is current on + * another thread, you have to @ref release() it there first --- an + * OpenGL context can't be current in multiple threads at the same + * time. */ bool makeCurrent(); /** * @brief Release current context + * @m_since_latest * + * Releases a context previously made current using @ref makeCurrent(). * Prints error message and returns @cpp false @ce on failure, * otherwise returns @cpp true @ce. */ diff --git a/src/Magnum/Platform/WindowlessGlxApplication.cpp b/src/Magnum/Platform/WindowlessGlxApplication.cpp index 4a6d1a249..d744cb2bb 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.cpp +++ b/src/Magnum/Platform/WindowlessGlxApplication.cpp @@ -3,6 +3,7 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš + Copyright © 2021 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index f58685d55..68dc2d591 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -5,6 +5,7 @@ Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Vladimír Vondruš + Copyright © 2021 Konstantinos Chatzilygeroudis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), @@ -142,13 +143,18 @@ class WindowlessGlxContext { * @brief Make the context current * * Prints error message and returns @cpp false @ce on failure, - * otherwise returns @cpp true @ce. + * otherwise returns @cpp true @ce. If the context is current on + * another thread, you have to @ref release() it there first --- an + * OpenGL context can't be current in multiple threads at the same + * time. */ bool makeCurrent(); /** * @brief Release current context + * @m_since_latest * + * Releases a context previously made current using @ref makeCurrent(). * Prints error message and returns @cpp false @ce on failure, * otherwise returns @cpp true @ce. */