Implementing a Texture - Revision history

Byob: /* OpenCL Code */

2020-04-06T17:21:42Z

OpenCL Code

← Older revision		Revision as of 19:21, 6 April 2020
Line 90:		Line 90:

	== OpenCL Code ==		== OpenCL Code ==

			'''Note: This section is currently outdated after the OpenCL material/texture rework in v2.4!'''

	Files that need to be edited:		Files that need to be edited:

Byob at 20:13, 6 June 2019

2019-06-06T20:13:24Z

Byob: /* Creating the source file */

2019-06-06T20:08:23Z

Creating the source file

@@ Line 17: / Line 17: @@
 ==== Creating the source file ====
-TODO: Description of the methods that need to be implemented:
+Each texture has to implement the following methods:
-* GetFloatValue
+===== Y() =====
-What do they do, what should they return?
+The average luminance of the whole texture.
 ==== Modifying the base texture header ====

Byob at 16:23, 20 March 2019

2019-03-20T16:23:34Z

← Older revision		Revision as of 18:23, 20 March 2019
Line 1:		Line 1:
			Note: this guide is not yet finished. All necessary steps for creating are texture are included, with C++ and OpenCL code, but some of the steps are not explained in detail yet.

	== C++ Code ==		== C++ Code ==
	Files that need to be created:		Files that need to be created:

Byob: /* Creating the source file */

2019-03-20T16:17:22Z

Creating the source file

← Older revision		Revision as of 18:17, 20 March 2019
Line 21:		Line 21:
	* Filter		* Filter
	* Y		* Y
	* Bump
	etc.		etc.

Byob: /* OpenCL Code */

2019-03-20T16:16:18Z

OpenCL Code

← Older revision		Revision as of 18:16, 20 March 2019
Line 69:		Line 69:
	== OpenCL Code ==		== OpenCL Code ==

	~~TODO~~		Files that need to be edited:
			* include/slg/textures/texture_funcs.cl
			* include/slg/textures/texture_types.cl
			* src/slg/engines/pathoclbase/compiletextures.cpp
			* src/slg/engines/pathoclbase/pathoclbaseoclthreadkernels.cpp

			==== include/slg/textures/texture_funcs.cl ====

			<pre>
			//------------------------------------------------------------------------------
			// Your texture
			//------------------------------------------------------------------------------

			#if defined(PARAM_ENABLE_TEX_YOURS)

			OPENCL_FORCE_NOT_INLINE float YourTexture_ConstEvaluateFloat(__global HitPoint *hitPoint,
			const float tex1, const float tex2) {
			// The actual work is done here (this function is executed when a float value of your texture is requested)
			return tex1 * tex2;
			}

			OPENCL_FORCE_NOT_INLINE float3 YourTexture_ConstEvaluateSpectrum(__global HitPoint *hitPoint,
			const float3 tex1, const float3 tex2) {
			// The actual work is done here (this function is executed when a color value of your texture is requested)
			return tex1 * tex2;
			}

			#endif
			</pre>

			==== include/slg/textures/texture_types.cl ====

			Add a new texture type for your texture to the <code>TextureType</code> enum.

			If your texture has input parameters, create a new struct in the form
			<pre>
			typedef struct {
			unsigned int tex1Index, tex2Index;
			} YourTexParam;
			</pre>
			and add it to the big union in the <code>Texture</code> struct.

			==== src/slg/engines/pathoclbase/compiletextures.cpp ====

			Include the C++ header of your texture.

			Add a new <code>case</code> for your function to the <code>CompiledScene::CompileTextures()</code> method.

			Add a new <code>case</code> for your function to the <code>CompiledScene::GetTexturesEvaluationSourceCode()</code> method.

			==== src/slg/engines/pathoclbase/pathoclbaseoclthreadkernels.cpp ====

			Add a new <code>if</code> statement for your texture to the <code>PathOCLBaseOCLRenderThread::InitKernels()</code> method.

Byob at 10:33, 19 June 2018

2018-06-19T10:33:34Z

← Older revision		Revision as of 12:33, 19 June 2018
Line 10:		Line 10:

	Commit with example: adding the "Divide" texture: https://github.com/LuxCoreRender/LuxCore/commit/ce6e23c244b1bb426c1dcd13099a41982e565b88		Commit with example: adding the "Divide" texture: https://github.com/LuxCoreRender/LuxCore/commit/ce6e23c244b1bb426c1dcd13099a41982e565b88

			==== Creating the header file ====

			==== Creating the source file ====

			TODO: Description of the methods that need to be implemented:

			* GetFloatValue
			* GetSpectrumValue
			* Filter
			* Y
			* Bump
			etc.

			What do they do, what should they return?

	==== Modifying the base texture header ====		==== Modifying the base texture header ====

Byob: /* Modifying CMakeLists.txt */

2018-06-18T14:15:47Z

Modifying CMakeLists.txt

← Older revision		Revision as of 16:15, 18 June 2018
Line 24:		Line 24:

	==== Modifying CMakeLists.txt ====		==== Modifying CMakeLists.txt ====
	~~TODO~~
			Open src/slg/CMakeLists.txt<br>
			Search for <code>set(SLG_CORE_SRCS</code> and add your source filepath among the other textures (they are sorted alphabetically).

	==== Compile and Test ====		==== Compile and Test ====

Byob: /* Modifying Sceneparse */

2018-06-18T14:13:55Z

Modifying Sceneparse

← Older revision		Revision as of 16:13, 18 June 2018
Line 17:		Line 17:

	==== Modifying Sceneparse ====		==== Modifying Sceneparse ====
	~~TODO~~
			Open src/slg/scene/parsetextures.cpp<br>
			Include the new header file you created for your texture (the list is alphabetic).

			Next, go to the method <code>Scene::CreateTexture</code>, scroll down until the end of the big <code>if/else</code> statement and add a new <code>else if</code> for your texture.

	==== Modifying CMakeLists.txt ====		==== Modifying CMakeLists.txt ====

Byob: /* Modifying the base texture header */

2018-06-18T14:09:28Z

Modifying the base texture header

← Older revision		Revision as of 16:09, 18 June 2018
Line 13:		Line 13:
	==== Modifying the base texture header ====		==== Modifying the base texture header ====

	Open the file include/slg/textures/texture.h		Open the file include/slg/textures/texture.h<br>
	Add your new texture type to the <code>TextureType</code> enum.		Add your new texture type to the <code>TextureType</code> enum.

← Older revision		Revision as of 22:13, 6 June 2019
Line 13:		Line 13:
	Commit with example: adding the "Divide" texture: https://github.com/LuxCoreRender/LuxCore/commit/ce6e23c244b1bb426c1dcd13099a41982e565b88		Commit with example: adding the "Divide" texture: https://github.com/LuxCoreRender/LuxCore/commit/ce6e23c244b1bb426c1dcd13099a41982e565b88

	==== Creating the header file ====		=== Creating the header file ===

	==== Creating the source file ====		=== Creating the source file ===

	Each texture has to implement the following methods:		Each texture has to implement the following methods:

	===== Y() =====		==== Y() ====

	The average luminance of the whole texture.		The average luminance of the whole texture.
Line 26:		Line 26:
	In case this information cannot be computed, 1.0 should be returned.		In case this information cannot be computed, 1.0 should be returned.

	===== Filter() =====		==== Filter() ====

	The average mean of the whole texture.		The average mean of the whole texture.
Line 33:		Line 33:
	In case this information cannot be computed, 1.0 should be returned.		In case this information cannot be computed, 1.0 should be returned.

	===== GetFloatValue(HitPoint) =====		==== GetFloatValue(HitPoint) ====

	This method is called when a texture slot of a material/volume/texture requests a float value from the texture. For example, the roughness slot of a glossy2 material would call this method, because the roughness is a floating point input.		This method is called when a texture slot of a material/volume/texture requests a float value from the texture. For example, the roughness slot of a glossy2 material would call this method, because the roughness is a floating point input.
Line 39:		Line 39:
	It should return the float value at this particular hitpoint.		It should return the float value at this particular hitpoint.

	===== GetSpectrumValue(HitPoint) =====		==== GetSpectrumValue(HitPoint) ====

	This method is called when a Spectrum (RGB color) value is requested from the texture.		This method is called when a Spectrum (RGB color) value is requested from the texture.
Line 48:		Line 48:
	<pre>return Spectrum(GetFloatValue(hitPoint));</pre>		<pre>return Spectrum(GetFloatValue(hitPoint));</pre>

	==== Modifying the base texture header ====		=== Modifying the base texture header ===

	Open the file include/slg/textures/texture.h<br>		Open the file include/slg/textures/texture.h<br>
	Add your new texture type to the <code>TextureType</code> enum.		Add your new texture type to the <code>TextureType</code> enum.

	==== Modifying Sceneparse ====		=== Modifying Sceneparse ===

	Open src/slg/scene/parsetextures.cpp<br>		Open src/slg/scene/parsetextures.cpp<br>
Line 60:		Line 60:
	Next, go to the method <code>Scene::CreateTexture</code>, scroll down until the end of the big <code>if/else</code> statement and add a new <code>else if</code> for your texture.		Next, go to the method <code>Scene::CreateTexture</code>, scroll down until the end of the big <code>if/else</code> statement and add a new <code>else if</code> for your texture.

	==== Modifying CMakeLists.txt ====		=== Modifying CMakeLists.txt ===

	Open src/slg/CMakeLists.txt<br>		Open src/slg/CMakeLists.txt<br>
	Search for <code>set(SLG_CORE_SRCS</code> and add your source filepath among the other textures (they are sorted alphabetically).		Search for <code>set(SLG_CORE_SRCS</code> and add your source filepath among the other textures (they are sorted alphabetically).

	==== Compile and Test ====		=== Compile and Test ===
	To test your plugin, compile LuxCore: [[Compiling_LuxCore]]		To test your plugin, compile LuxCore: [[Compiling_LuxCore]]

Line 97:		Line 97:
	* src/slg/engines/pathoclbase/pathoclbaseoclthreadkernels.cpp		* src/slg/engines/pathoclbase/pathoclbaseoclthreadkernels.cpp

	==== include/slg/textures/texture_funcs.cl ====		=== include/slg/textures/texture_funcs.cl ===

	<pre>		<pre>
Line 121:		Line 121:
	</pre>		</pre>

	==== include/slg/textures/texture_types.cl ====		=== include/slg/textures/texture_types.cl ===

	Add a new texture type for your texture to the <code>TextureType</code> enum.		Add a new texture type for your texture to the <code>TextureType</code> enum.
Line 133:		Line 133:
	and add it to the big union in the <code>Texture</code> struct.		and add it to the big union in the <code>Texture</code> struct.

	==== src/slg/engines/pathoclbase/compiletextures.cpp ====		=== src/slg/engines/pathoclbase/compiletextures.cpp ===

	Include the C++ header of your texture.		Include the C++ header of your texture.
Line 141:		Line 141:
	Add a new <code>case</code> for your function to the <code>CompiledScene::GetTexturesEvaluationSourceCode()</code> method.		Add a new <code>case</code> for your function to the <code>CompiledScene::GetTexturesEvaluationSourceCode()</code> method.

	==== src/slg/engines/pathoclbase/pathoclbaseoclthreadkernels.cpp ====		=== src/slg/engines/pathoclbase/pathoclbaseoclthreadkernels.cpp ===

	Add a new <code>if</code> statement for your texture to the <code>PathOCLBaseOCLRenderThread::InitKernels()</code> method.		Add a new <code>if</code> statement for your texture to the <code>PathOCLBaseOCLRenderThread::InitKernels()</code> method.