From 2cf8fbd76ac0953bb5c586a666bc7174541ef530 Mon Sep 17 00:00:00 2001 From: Marcus Hudritsch Date: Sat, 6 Jul 2024 11:48:26 +0200 Subject: [PATCH] Fixe actions for doc generation --- .github/workflows/build-docs.yml | 3 --- .github/workflows/deploy-pages.yml | 3 +++ data/shaders/PBR_BRDFIntegration.frag | 4 ++-- data/shaders/PBR_BRDFIntegration.vert | 4 ++-- data/shaders/PBR_CylinderToCubeMap.frag | 8 ++++---- data/shaders/PBR_IrradianceConvolution.frag | 5 ++--- data/shaders/PBR_PrefilterRoughness.frag | 6 +++--- data/shaders/ParticleTFOLD.frag | 6 +++--- data/shaders/PerPixBlinnTmNmEarth.frag | 2 +- data/shaders/PerPixCook.frag | 6 +++--- data/shaders/PerPixCook.vert | 6 +++--- data/shaders/PerPixCookTm.frag | 6 +++--- data/shaders/PerPixCookTm.vert | 6 +++--- data/shaders/PerPixTmBackgroundSm.frag | 4 ++-- data/shaders/PerPixTmBackgroundSm.vert | 4 ++-- data/shaders/PerPixTmBackgroundSmExternal.frag | 4 ++-- data/shaders/RefractReflectDisp.frag | 4 ++-- data/shaders/StereoOculusDistortionMesh.frag | 2 +- data/shaders/StereoOculusDistortionMesh.vert | 2 +- 19 files changed, 42 insertions(+), 43 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 88a49dea..a4662a2d 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -2,9 +2,6 @@ name: Build Docs on: workflow_dispatch: - push: - branches: - - main jobs: build: diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 792f7811..ff33fbae 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -2,6 +2,9 @@ name: Deploy GitHub Pages on: workflow_dispatch: + push: + branches: + - main permissions: contents: read diff --git a/data/shaders/PBR_BRDFIntegration.frag b/data/shaders/PBR_BRDFIntegration.frag index 4b1e6078..de06d22a 100644 --- a/data/shaders/PBR_BRDFIntegration.frag +++ b/data/shaders/PBR_BRDFIntegration.frag @@ -1,7 +1,7 @@ /** * \file PBR_BRDFIntegration.frag - * \brief GLSL fragment program for generating a BRDF integration map, -// which is the second part of the specular integral. + * \details GLSL fragment program for generating a BRDF integration map, + * which is the second part of the specular integral. * \date April 2018 * \authors Carlos Arauz, Marcus Hudritsch, Marino von Wattenwyl * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PBR_BRDFIntegration.vert b/data/shaders/PBR_BRDFIntegration.vert index a66fcd03..21f1ad67 100644 --- a/data/shaders/PBR_BRDFIntegration.vert +++ b/data/shaders/PBR_BRDFIntegration.vert @@ -1,7 +1,7 @@ /** * \file PBR_BRDFIntegration.vert - * \brief GLSL vertex program for generating a BRDF integration map, which -// is the second part of the specular integral. + * \details GLSL vertex program for generating a BRDF integration map, which + * is the second part of the specular integral. * \date April 2018 * \authors Carlos Arauz, Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PBR_CylinderToCubeMap.frag b/data/shaders/PBR_CylinderToCubeMap.frag index d306aded..915dbd84 100644 --- a/data/shaders/PBR_CylinderToCubeMap.frag +++ b/data/shaders/PBR_CylinderToCubeMap.frag @@ -1,9 +1,9 @@ /** * \file PBR_CylinderToCubeMap.frag - * \brief GLSL fragment program which takes fragment's direction to sample -// the equirectangular map as if it is a cube map. Based on the -// physically based rendering (PBR) tutorial with GLSL by Joey de -// Vries on https://learnopengl.com/PBR/IBL/Diffuse-irradiance + * \details GLSL fragment program which takes fragment's direction to sample + * the equirectangular map as if it is a cube map. Based on the + * physically based rendering (PBR) tutorial with GLSL by Joey de + * Vries on https://learnopengl.com/PBR/IBL/Diffuse-irradiance * \authors Carlos Arauz, Marcus Hudritsch * \date April 2018 * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PBR_IrradianceConvolution.frag b/data/shaders/PBR_IrradianceConvolution.frag index 00f9af3c..641f4dd4 100644 --- a/data/shaders/PBR_IrradianceConvolution.frag +++ b/data/shaders/PBR_IrradianceConvolution.frag @@ -1,8 +1,7 @@ /** * \file PBR_IrradianceConvolution.frag - * \brief GLSL fragment program to generate an irradiance map by -// convoluting of an environment map. -// Author: + * \details GLSL fragment program to generate an irradiance map by + * convoluting of an environment map. * \date April 2018 * \authors Carlos Arauz, Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PBR_PrefilterRoughness.frag b/data/shaders/PBR_PrefilterRoughness.frag index b11bd0bd..a59abef6 100644 --- a/data/shaders/PBR_PrefilterRoughness.frag +++ b/data/shaders/PBR_PrefilterRoughness.frag @@ -1,8 +1,8 @@ /** * \file PBR_PrefilterRoughness.frag - * \brief GLSL fragment program to generate a prefiltered environment map -// using convolution, similar to the irradiance convolution map but -// taking a roughness value into account. + * \details GLSL fragment program to generate a prefiltered environment map + using convolution, similar to the irradiance convolution map but + taking a roughness value into account. * \date April 2018 * \authors Carlos Arauz. Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/ParticleTFOLD.frag b/data/shaders/ParticleTFOLD.frag index 05eb2d51..879f4bea 100644 --- a/data/shaders/ParticleTFOLD.frag +++ b/data/shaders/ParticleTFOLD.frag @@ -1,8 +1,8 @@ /** * \file ParticleTF.frag - * \brief Simple GLSL fragment program for particle system updating this -// shader is never used because of the transform feedback and the -// rasterization off. + * \brief Simple GLSL fragment program for particle system updating this + * \details This shader is never used because of the transform feedback and + * the rasterization off. * \date December 2021 * \authors Affolter Marc * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixBlinnTmNmEarth.frag b/data/shaders/PerPixBlinnTmNmEarth.frag index a2ac45e8..f30cdc73 100644 --- a/data/shaders/PerPixBlinnTmNmEarth.frag +++ b/data/shaders/PerPixBlinnTmNmEarth.frag @@ -1,6 +1,6 @@ /** * \file PerPixBlinnTmNmEarth.frag - * \brief OGLSL parallax bump mapping + * \brief OGLSL parallax bump mapping * \date July 2014 * \authors Markus Knecht, Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixCook.frag b/data/shaders/PerPixCook.frag index d0dc5645..63c046b2 100644 --- a/data/shaders/PerPixCook.frag +++ b/data/shaders/PerPixCook.frag @@ -1,8 +1,8 @@ /** * \file PerPixCook.frag - * \brief GLSL fragment shader for Cook-Torrance physical based rendering. -// Based on the physically based rendering (PBR) tutorial with GLSL -// from Joey de Vries on https://learnopengl.com/#!PBR/Theory + * \details GLSL fragment shader for Cook-Torrance physical based rendering. + * Based on the physically based rendering (PBR) tutorial with GLSL + * from Joey de Vries on https://learnopengl.com/#!PBR/Theory * \date July 2017 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixCook.vert b/data/shaders/PerPixCook.vert index 168bc264..88fcdf49 100644 --- a/data/shaders/PerPixCook.vert +++ b/data/shaders/PerPixCook.vert @@ -1,8 +1,8 @@ /** * \file PerPixCook.vert - * \brief GLSL vertex shader for Cook-Torrance physical based rendering. -// Based on the physically based rendering (PBR) tutorial with GLSL -// from Joey de Vries on https://learnopengl.com/#!PBR/Theory + * \details GLSL vertex shader for Cook-Torrance physical based rendering. + * Based on the physically based rendering (PBR) tutorial with GLSL + * from Joey de Vries on https://learnopengl.com/#!PBR/Theory * \date July 2014 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixCookTm.frag b/data/shaders/PerPixCookTm.frag index 1c33a803..8a9e58a3 100644 --- a/data/shaders/PerPixCookTm.frag +++ b/data/shaders/PerPixCookTm.frag @@ -1,8 +1,8 @@ /** * \file PerPixCookTm.frag - * \brief GLSL fragment shader for Cook-Torrance physical based rendering. -// Based on the physically based rendering (PBR) tutorial with GLSL -// from Joey de Vries on https://learnopengl.com/#!PBR/Theory + * \details GLSL fragment shader for Cook-Torrance physical based rendering. + * Based on the physically based rendering (PBR) tutorial with GLSL + * from Joey de Vries on https://learnopengl.com/#!PBR/Theory * \date July 2017 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixCookTm.vert b/data/shaders/PerPixCookTm.vert index 198a311d..128d87b3 100644 --- a/data/shaders/PerPixCookTm.vert +++ b/data/shaders/PerPixCookTm.vert @@ -1,8 +1,8 @@ /** * \file PerPixCookTm.vert - * \brief GLSL vertex shader for Cook-Torrance physical based rendering. -// Based on the physically based rendering (PBR) tutorial with GLSL -// from Joey de Vries on https://learnopengl.com/#!PBR/Theory + * \details GLSL vertex shader for Cook-Torrance physical based rendering. + * Based on the physically based rendering (PBR) tutorial with GLSL + * from Joey de Vries on https://learnopengl.com/#!PBR/Theory * \date July 2014 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixTmBackgroundSm.frag b/data/shaders/PerPixTmBackgroundSm.frag index 8ac45a88..86b51b3f 100644 --- a/data/shaders/PerPixTmBackgroundSm.frag +++ b/data/shaders/PerPixTmBackgroundSm.frag @@ -1,7 +1,7 @@ /** * \file PerPixTmBackgroundSm.frag - * \brief GLSL fragment shader for background texture mapping with -// shadow mapping + * \details GLSL fragment shader for background texture mapping with + * shadow mapping * \date November 2020 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixTmBackgroundSm.vert b/data/shaders/PerPixTmBackgroundSm.vert index e1a883fa..d0d676c0 100644 --- a/data/shaders/PerPixTmBackgroundSm.vert +++ b/data/shaders/PerPixTmBackgroundSm.vert @@ -1,7 +1,7 @@ /** * \file PerPixTmBackground.vert - * \brief GLSL vertex shader for background texture mapping with -// shadow mapping + * \details GLSL vertex shader for background texture mapping with + * shadow mapping * \date November 2020 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/PerPixTmBackgroundSmExternal.frag b/data/shaders/PerPixTmBackgroundSmExternal.frag index 5abf1601..cd4c2613 100644 --- a/data/shaders/PerPixTmBackgroundSmExternal.frag +++ b/data/shaders/PerPixTmBackgroundSmExternal.frag @@ -1,7 +1,7 @@ /** * \file PerPixTmBackgroundSm.frag - * \brief GLSL fragment shader for background texture mapping with -// shadow mapping + * \detials GLSL fragment shader for background texture mapping with + * shadow mapping * \date November 2020 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/RefractReflectDisp.frag b/data/shaders/RefractReflectDisp.frag index 30c2db76..e73d9192 100644 --- a/data/shaders/RefractReflectDisp.frag +++ b/data/shaders/RefractReflectDisp.frag @@ -1,7 +1,7 @@ /** * \file RefractReflectDisp.frag - * \brief GLSL fragment program for refraction- & reflection mapping with -// chromatic dispersion + * \details GLSL fragment program for refraction- & reflection mapping with + * chromatic dispersion * \date July 2014 * \authors Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/StereoOculusDistortionMesh.frag b/data/shaders/StereoOculusDistortionMesh.frag index e9d4dd77..9272ed71 100644 --- a/data/shaders/StereoOculusDistortionMesh.frag +++ b/data/shaders/StereoOculusDistortionMesh.frag @@ -1,6 +1,6 @@ /** * \file StereoOculus.frag - * \brief Oculus Rift Distortion Shader + * \brief Oculus Rift Distortion Shader * \date November 2013 * \authors Marc Wacker, Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0 diff --git a/data/shaders/StereoOculusDistortionMesh.vert b/data/shaders/StereoOculusDistortionMesh.vert index 59cbb28a..3de26855 100644 --- a/data/shaders/StereoOculusDistortionMesh.vert +++ b/data/shaders/StereoOculusDistortionMesh.vert @@ -1,6 +1,6 @@ /** * \file StereoOculusDistortionMesh.vert - * \brief Oculus Rift Distortion Shader + * \brief Oculus Rift Distortion Shader * \date November 2013 * \authors Marc Wacker, Marcus Hudritsch * \copyright http://opensource.org/licenses/GPL-3.0