Skip to content

Commit d6bae89

Browse files
committed
4 CWD docs
1 parent a7e1c78 commit d6bae89

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

include/nbl/system/IApplicationFramework.h

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,35 @@ class IApplicationFramework : public core::IReferenceCounted
4141
virtual void onAppInitialized_impl() {}
4242
virtual void onAppTerminated_impl() {}
4343

44-
system::path localInputCWD, localOutputCWD, sharedInputCWD, sharedOutputCWD;
44+
/*
45+
****************** Current Working Directories ********************
46+
Each Nabla app has 4 pre-defined working directories. You can change them to your liking.
47+
*******************************************************************
48+
*/
49+
50+
51+
/*
52+
This is a CWD which is used for reading app-local assets.
53+
Do NOT try writing to this path if you wan't your app to work on Android because on Android this CWD is located inside a readonly APK archive.
54+
55+
To add files to your assets directory, create an "assets" directory in your app's source directory
56+
*/
57+
system::path localInputCWD;
58+
59+
/*
60+
This is a CWD used to output app-local data e.g. screenshots
61+
*/
62+
system::path localOutputCWD;
63+
64+
/*
65+
The CWD for input data that can be shared among apps, like the "examples_tests/media" directory for Nabla examples
66+
*/
67+
system::path sharedInputCWD;
68+
69+
/*
70+
This CWD is used to output data that can be shared between apps e.g. quantization cache
71+
*/
72+
system::path sharedOutputCWD;
4573
};
4674

4775
}

0 commit comments

Comments
 (0)