Commit 36678f4a authored by torsten.hopp's avatar torsten.hopp
Browse files

Update README.md until before helper functions

parent 824e5218
...@@ -85,30 +85,36 @@ easyExample("easy",1) ...@@ -85,30 +85,36 @@ easyExample("easy",1)
## <a name="howToBuild">How to build it ## <a name="howToBuild">How to build it
### raytracingBuilder ### raytracingBuilder
Build for raytracing functions and shader. If vulkan is installed and the files has same relativ position as the repo, the build works by itself and raytracingBuilderWrapper can be used. MATLAB function for building raytracing functions and shader. If vulkan is installed and all files have the same relativ position as in this repository, the build works by itself and raytracingBuilderWrapper can be used, i.e.
```matlab ```matlab
raytracingBuilder("","","","","",1) raytracingBuilder("","","","","",1)
``` ```
If you call the builder like shown, you can also use raytracingBuilderWrapper, which doesn't need inputs, because of default usage. is equivalent to using `raytracingBuilderWrapper`.
The raytracingBuilder it is possible to parameterize the build process:
```matlab
raytracingBuilder(cSourceFilesPath,cHeadersFilesPath,vulkanIncludePath,VulkanLibPath,shaderBuildPath,buildShader)
```
- Input: - Input:
- **cSourceFilesPath**: new c source file path <br/> - **cSourceFilesPath**: C source file path. Should point to the source files located in subfolder `Raytracing\HeadlessRaytracingWithMex\HeadlessRaytracingWithMex\Source` of this repository <br/>
- **cHeadersFilesPath**: new c header file path<br/> - **cHeadersFilesPath**: C header file path. Should point to the header files located in subfolder `\Raytracing\HeadlessRaytracingWithMex\HeadlessRaytracingWithMex\Header` of this repository<br/>
- **vulkanIncludePath**: new vulkan include file path <br/> - **vulkanIncludePath**: Vulkan lib file path: path to the `lib` subfolder of the Vulkan installaation, e.g. `C:\VulkanSDK\1.2.131.2\Include` <br/>
- **VulkanLibPath**: new vulkan lib file path <br/> - **VulkanLibPath**: Vulkan lib file path: path to the `lib` subfolder of the Vulkan installaation, e.g. `C:\VulkanSDK\1.2.131.2\Lib` <br/>
- **shaderBuildPath**: new shader file path <br/> - **shaderBuildPath**: Shader file path. By default points to `\Raytracing\HeadlessRaytracingWithMex\HeadlessRaytracingWithMex\Source\Shaders`<br/>
- **buildShader**: bool if shader should also compiled. 0 = no shader build, 1 = build shader <br/> - **buildShader**: flag whether shader should also be compiled. Allowed values are 0 = shader will not be built, 1 = shader will be built.<br/>
- Output: generated files in the expected folder <br/> - Output: none<br/>
### raytracingBuilderWrapper ### raytracingBuilderWrapper
Starts raytracingBuilder with default settings. If vulkan is installed and the files has same relativ position, the build works from alone, else use raytracingBuilder and set parameters manually. Starts raytracingBuilder with default settings. Supposed to work if vulkan is installed and the files have the same relative position as in this repository. If this is not the case, please use raytracingBuilder and set parameters manually.
```matlab ```matlab
raytracingBuilderWrapper() raytracingBuilderWrapper()
``` ```
- Input: none <br/> - Input: none <br/>
- Output: generated files in the expected folder (equal to raytracingBuilder) <br/> - Output: none <br/>
## Helper Functions ## Helper Functions
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment