birkeh
/
o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
development
monroegm-disable-blank-issue-2
main
2111.2
2111.1
2107.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f47e71da36'
${ noResults }
o3de/Gems/Atom/Feature/Common/Assets/ShaderResourceGroups
History
Steve Pham b4a2edec6a
Final update copyright headers to reference license files at the repo root (#1693) 
* Final update copyright headers to reference license files at the repo root

Signed-off-by: spham <spham@amazon.com>

* Fix copyright validator unit tests to support the stale O3DE header scenario

Signed-off-by: spham <spham@amazon.com>
 		5 years ago
..
CoreLights Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
Decals Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
PostProcessing Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
SkyBox Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
README.md Initial commit 5 years ago
SceneSrg.azsli Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
SceneSrgAll.azsli Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
SceneTimeSrg.azsli Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
ViewSrg.azsli Final update copyright headers to reference license files at the repo root (#1693) 5 years ago
ViewSrgAll.azsli Final update copyright headers to reference license files at the repo root (#1693) 5 years ago

README.md

There must be only one scenesrg.srgi and one viewsrg.srgi files per game project. They are always located in <DevFolder>/<Project>/ShaderLib, This location can not change, otherwise the asset processor won't be able to find the SceneSrg and the ViewSrg.

Each game project can customize the content of scenesrg.srgi and viewsrg.srgi as needed.

The preprocessor that works on behalf of the Shader Compiler defines the following priority for paths used to search for included files (ordered here from highest to lowest priority):

  1. Paths defined in the file <DevFolder>/<Project>/Config/shader_global_build_options.json
    1.1. Each path inside shader_global_build_options.json is relative to the <DevFolder>/ path.

  2. All valid scan folders returned by the Asset Processor with added "ShaderLib/" folder at the end. Here is a short summary of the folders that are scanned by the AP:
    2.1. Folders specified in <DevFolder>/AssetProcessorPlatformConfig.ini
    2.2. The Asset/ subdirectory within each Gem enabled for the Game Project. (Recursive). Examples:
    2.2.1. <DevFolder>/Gems/Atom/Asset/
    2.2.2. <DevFolder>/Gems/Camera/Asset/ 2.3. The root folder of each Gem enabled for the Game Project. (Non Recursive). Examples:
    2.2.1. <DevFolder>/Gems/Atom/
    2.2.2. <DevFolder>/Gems/Camera/

  3. Finally, at the lowest priority is the folder: <DevFolder>/Gems/

With that being said, if a project doesn't provide its own shader_global_build_options.json then each time an azsl/azsli calls
#include <scenesrg.srgi>
it will default to
<DevFolder>/<Project>/ShaderLib/scenesrg.srgi
Similarly occurs with #include <viewsrg.srgi>

Because documents may become stale from time to time, the ultimate source of truth on how include paths are resolved is the source file
<DevFolder>/Gems/Atom/Asset/Shader/Code/Source/Editor/CommonFiles/Preprocessor.cpp
Function name: void InitializePreprocessorOptions(...)
And yes, even the location of that file may change in the future ;-).