Skip to content

Commit e8e5a4b

Browse files
committed
update docs
1 parent a7c99b6 commit e8e5a4b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/nbl/builtin/utils.cmake

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Assigns builtin resources to a bundle a target library will be created with
2-
# _BUNDLE_NAME_ is a bundle name, must be a valid CMake variable
2+
# _BUNDLE_NAME_ is a bundle name, must be a valid CMake list variable
33
# _LBR_PATH_ is a path to builtin resource
44

55
macro(LIST_BUILTIN_RESOURCE _BUNDLE_NAME_ _LBR_PATH_)
@@ -26,7 +26,7 @@ endmacro()
2626

2727
# Creates a library with builtin resources for given bundle
2828
# _TARGET_NAME_ is name of a target library that will be created
29-
# _BUNDLE_NAME_ is a bundle name builtin resources are associated with
29+
# _BUNDLE_NAME_ a list variable populated using LIST_BUILTIN_RESOURCE
3030
# _BUNDLE_SEARCH_DIRECTORY_ is an absolute search directory path for builtin resorces for given bundle
3131
# _BUNDLE_ARCHIVE_ABSOLUTE_PATH_ is a "absolute path" for an archive which will store a given bundle of builtin resources, must be relative _BUNDLE_SEARCH_DIRECTORY_
3232
# _NAMESPACE_ is a C++ namespace builtin resources will be wrapped into
@@ -38,7 +38,7 @@ endmacro()
3838
# and then create builtin resource target with the resource above using
3939
# ADD_CUSTOM_BUILTIN_RESOURCES("aTarget" SOME_RESOURCES_TO_EMBED "${NBL_ROOT_PATH}/include" "nbl/builtin" "myns::builtin" "${NBL_ROOT_PATH_BINARY}/include" "${NBL_ROOT_PATH_BINARY}/src")
4040
# a real absolute path to the resource on the disk would be ${NBL_ROOT_PATH}/include/nbl/builtin/glsl/blit/default_compute_normalization.comp
41-
# the builtin resource path seen in an archive would be "nbl/builtin/builtin/glsl/blit/default_compute_normalization.comp" where "nbl/builtin" would be an absolute path for an archive
41+
# the builtin resource path seen in Nabla filesystem would be "nbl/builtin/builtin/glsl/blit/default_compute_normalization.comp" where "nbl/builtin" would be an absolute path for an archive
4242

4343
function(ADD_CUSTOM_BUILTIN_RESOURCES _TARGET_NAME_ _BUNDLE_NAME_ _BUNDLE_SEARCH_DIRECTORY_ _BUNDLE_ARCHIVE_ABSOLUTE_PATH_ _NAMESPACE_ _OUTPUT_INCLUDE_SEARCH_DIRECTORY_ _OUTPUT_SOURCE_DIRECTORY_)
4444
if(NOT DEFINED _Python3_EXECUTABLE)

0 commit comments

Comments
 (0)