Atlas: /* Version List */

2024-10-27T14:25:45Z

Version List

← Older revision		Revision as of 14:25, 27 October 2024
Line 367:		Line 367:
	\| 2.3.1		\| 2.3.1
	\|		\|
			* [[Nintendo Switch Online Playtest Program]]
	* [[Super Mario Party Jamboree]]		* [[Super Mario Party Jamboree]]
	\|}		\|}

Atlas: /* Version List */

2024-10-13T20:50:45Z

Version List

← Older revision		Revision as of 20:50, 13 October 2024
Line 364:		Line 364:
	* [[The Legend of Zelda: Echoes of Wisdom]]		* [[The Legend of Zelda: Echoes of Wisdom]]
	* [[The Legend of Zelda: Tears of the Kingdom]]		* [[The Legend of Zelda: Tears of the Kingdom]]
			\|-
			\| 2.3.1
			\|
			* [[Super Mario Party Jamboree]]
	\|}		\|}

Atlas: /* Version List */

2024-09-25T21:56:10Z

Version List

← Older revision		Revision as of 21:56, 25 September 2024
Line 362:		Line 362:
	* [[Paper Mario: The Thousand-Year Door]] (Nintendo Switch)		* [[Paper Mario: The Thousand-Year Door]] (Nintendo Switch)
	* [[Super Mario Bros. Wonder]]		* [[Super Mario Bros. Wonder]]
			* [[The Legend of Zelda: Echoes of Wisdom]]
	* [[The Legend of Zelda: Tears of the Kingdom]]		* [[The Legend of Zelda: Tears of the Kingdom]]
	\|}		\|}

Atlas: /* Version List */

2024-07-17T20:25:10Z

Version List

← Older revision		Revision as of 20:25, 17 July 2024
Line 359:		Line 359:
	\|		\|
	* [[F-ZERO 99]]		* [[F-ZERO 99]]
			* [[Nintendo World Championships: NES Edition]]
	* [[Paper Mario: The Thousand-Year Door]] (Nintendo Switch)		* [[Paper Mario: The Thousand-Year Door]] (Nintendo Switch)
	* [[Super Mario Bros. Wonder]]		* [[Super Mario Bros. Wonder]]

Atlas: /* Version List */

2024-05-23T14:45:47Z

Version List

← Older revision		Revision as of 14:45, 23 May 2024
Line 359:		Line 359:
	\|		\|
	* [[F-ZERO 99]]		* [[F-ZERO 99]]
			* [[Paper Mario: The Thousand-Year Door]] (Nintendo Switch)
	* [[Super Mario Bros. Wonder]]		* [[Super Mario Bros. Wonder]]
	* [[The Legend of Zelda: Tears of the Kingdom]]		* [[The Legend of Zelda: Tears of the Kingdom]]

Wexos: Imported from avsys wiki

2024-05-01T17:16:37Z

Imported from avsys wiki

New page

'''BNSH''' ('''B'''inary '''N'''X '''SH'''ader) is a shader file format used on the [[Nintendo Switch]]. It contains shader data.

= File Format =
== Header ==
The file format starts with the following header:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Char[8] || '''File magic'''. Always ''BNSH\0\0\0\0'' in ASCII, or 42 4E 53 4E 00 00 00 00.
|-
| 0x08 || UInt32 || '''[[#Version List|Version number]]'''.
|-
| 0x0C || UInt16 || {{BOM}}
|-
| 0x0E || Byte || '''Alignment shift'''. 1 << v, where v is this value is the alignment required by the file.
|-
| 0x0F || Byte || '''Target address size'''. Size of a pointer in bits, thus 64.
|-
| 0x10 || UInt32 || '''File name offset'''. Points directly to the string, and not to the length unlike all other strings.
|-
| 0x14 || UInt16 || A '''flag''' which is only used on runtime. One bit sets wether the file is relocated.
|-
| 0x16 || UInt16 || Offset to the '''first section'''.
|-
| 0x18 || UInt32 || '''[[#Relocation Table|Relocation table]] offset'''.
|-
| 0x1C || UInt32 || '''Size of the file''' in bytes.
|-
| 0x20 || Byte[64] || '''Reserved'''.
|}

== Shader Container ==
The shader container is the root and stores some general information about the shaders.

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Char[4] || '''Section magic'''. Always ''grsc'' in ASCII.
|-
| 0x04 || UInt32 || '''Next section offset'''.
|-
| 0x08 || UInt32 || '''Size of this section''' in bytes.
|-
| 0x0C || Byte[4] || '''Reserved'''.
|-
| 0x10 || UInt16 || '''API target type'''.
|-
| 0x12 || UInt16 || '''API target version'''.
|-
| 0x14 || Byte || '''Target code type.
|-
| 0x15 || Byte[3] || '''Reserved'''.
|-
| 0x18 || UInt32 || '''Compiler version'''.
|-
| 0x1C || UInt32 || '''Number of [[#Shader Variation|shader variation]]s'''.
|-
| 0x20 || Int64 || '''[[#Shader Variation|Shader variation]] array offset'''.
|-
| 0x28 || Int64 || '''[[#Memory Pool|Shader memory pool]] offset'''.
|-
| 0x30 || UInt64 || '''Low level compiler version'''.
|-
| 0x38 || Byte[40] || '''Reserved'''.
|}

=== Shader Variation ===
A shader variation contains a variation of a shader program. The binary program is used for binary files on the [[Nintendo Switch]] and the source program is used when testing PTCL files on a computer (which means it contains text shader data). The intermediate language program has an unknown usage. Each entry has the following structure:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''[[#Shader Program|Source program]] offset'''.
|-
| 0x08 || Int64 || '''[[#Shader Program|Intermediate language program]] offset'''.
|-
| 0x10 || Int64 || '''[[#Shader Program|Binary program]] offset'''.
|-
| 0x18 || Int64 || '''Parent [[#Shader Container|shader container]] offset'''.
|-
| 0x20 || Byte[32] || '''Reserved'''.
|}

==== Shader Program ====
The shader program structure specifies a shader program, which will be run on the GPU. It has the following structure:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Byte || '''Flags'''. 0 = Separation, 1= ResShader.
|-
| 0x01 || Byte || '''Code type'''.
{| class="wikitable"
|-
! ID !! Description
|-
| 0x00 || Binary
|-
| 0x01 || Intermediate language
|-
| 0x02 || Source
|-
| 0x03 || Source array
|}
|-
| 0x02 || Byte || '''Source format'''. Only GLSL (0) is supported.
|-
| 0x03 || Byte || '''Reserved'''.
|-
| 0x04 || Int32 || '''Binary format'''.
|-
| 0x08 || Int64 || '''[[#Shader Code|Vertex shader code]] offset'''.
|-
| 0x10 || Int64 || '''[[#Shader Code|Hull shader code]] offset'''.
|-
| 0x18 || Int64 || '''[[#Shader Code|Domain shader code]] offset'''.
|-
| 0x20 || Int64 || '''[[#Shader Code|Geometry shader code]] offset'''.
|-
| 0x28 || Int64 || '''[[#Shader Code|Fragment shader code]] offset'''.
|-
| 0x30 || Int64 || '''[[#Shader Code|Compute shader code]] offset'''.
|-
| 0x38 || Byte[40] || '''Reserved'''.
|-
| 0x60 || UInt32 || '''Object size'''. The maximum shader size in bytes to store shader object.
|-
| 0x64 || Byte[4] || '''Reserved'''.
|-
| 0x68 || Int64 || '''Object offset'''.
|-
| 0x70 || Int64 || '''Parent [[#Shader Variation|shader variation]] offset'''.
|-
| 0x78 || Int64 || '''[[#Shader Reflection|Shader reflection]] offset'''.
|-
| 0x80 || Byte[32] || '''Reserved'''.
|}

===== Shader Code =====
Depending on the code type, a different structure can be stored. This one is stored for source:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int64 || {{Unknown-left|'''Unknown'''.}}
|-
| 0x08 || Int64 || '''Data 1 offset'''.
|-
| 0x10 || Int64 || '''Data 2 offset'''.
|-
| 0x18 || UInt32 || '''Data 2 size''' in bytes.
|-
| 0x1C || UInt32 || '''Data 1 size''' in bytes.
|-
| 0x20 || Byte[32] || '''Padding'''.
|}

This one is stored for source array:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || '''Number of codes'''.
|-
| 0x02 || Byte[6] || '''Reserved'''.
|-
| 0x08 || Int64 || '''Code size array offset'''. Points to an array of UInt32s which stores the code size.
|-
| 0x10 || Int64 || '''Code data table offset'''. Points to an array of Int64s which points to the code datas'''.
|-
| 0x18 || Byte[8] || '''Reserved'''.
|}

===== Shader Reflection =====
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''[[#Shader Reflection Stage|Vertex reflection]] offset'''.
|-
| 0x08 || Int64 || '''[[#Shader Reflection Stage|Hull reflection]] offset'''.
|-
| 0x10 || Int64 || '''[[#Shader Reflection Stage|Domain reflection]] offset'''.
|-
| 0x18 || Int64 || '''[[#Shader Reflection Stage|Geometry reflection]] offset'''.
|-
| 0x20 || Int64 || '''[[#Shader Reflection Stage|Fragment reflection]] offset'''.
|-
| 0x28 || Int64 || '''[[#Shader Reflection Stage|Compute reflection]] offset'''.
|-
| 0x30 || Byte[16] || '''Reserved'''.
|}

====== Shader Reflection Stage ======
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Shader input [[#Dictionary|dictionary]] offset'''.
|-
| 0x08 || Int64 || '''Shader output [[#Dictionary|dictionary]] offset'''.
|-
| 0x10 || Int64 || '''Sampler [[#Dictionary|dictionary]] offset'''.
|-
| 0x18 || Int64 || '''Constant buffer [[#Dictionary|dictionary]] offset'''.
|-
| 0x20 || Int64 || '''Unordered access buffer [[#Dictionary|dictionary]] offset'''.
|-
| 0x28 || Int32 || '''Shader output offset''' into the array.
|-
| 0x2C || Int32 || '''Sampler offset''' into the array.
|-
| 0x30 || Int32 || '''Constant buffer offset''' into the array.
|-
| 0x34 || Int32 || '''Unordered access buffer offset''' into the array.
|-
| 0x38 || Int64 || '''Shader slot array offset'''.
|-
| 0x40 || UInt32 || '''Compute work group size X'''. The size of the workgroup's X dimension for compute shaders.
|-
| 0x44 || UInt32 || '''Compute work group size Y'''. The size of the workgroup's Y dimension for compute shaders.
|-
| 0x48 || UInt32 || '''Compute work group size Z'''. The size of the workgroup's Z dimension for compute shaders.
|-
| 0x4C || Int32 || '''Image offset''' into the array.
|-
| 0x50 || Int64 || '''Image [[#Dictionary|dictionary]] offset'''.
|-
| 0x58 || Byte[8] || '''Reserved'''.
|}

=== Memory Pool ===
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || {{Unknown-left|'''Memory pool property'''. Always 0x61.}}
|-
| 0x04 || UInt32 || '''Size of the memory pool''' in bytes.
|-
| 0x08 || Int64 || '''Offset to the memory pool'''. Points directly to the start of the data.
|-
| 0x10 || Byte[16] || '''Reserved'''.
|-
| 0x20 || Int64 || '''Memory pool offset'''. Points to an array of 0x140 empty bytes, with unknown use.
|-
| 0x28 || Byte[8] || '''Reserved'''.
|-
| 0x30 || Int64 || '''Current memory pool offset''', set at runtime.
|-
| 0x38 || Byte[24] || '''Reserved'''.
|}

== String Table ==
{{NX String Table}}
== Dictionary ==
{{NX Dictionary}}
== Relocation Table ==
{{NX Relocation Table}}

= Version List =
{|class="wikitable"
! Version !! Found in
|-
| 2.1.2
|
* [[1-2-Switch]]
* [[ARMS]]
* Nintendo Switch System BIOS (1.0.0 – 2.3.0)
* [[Mario Kart 8 Deluxe]]
* [[Mario Kart 8 Deluxe]] (S00018080-R00018076-A00000000 Prototype)
* [[Nintendo Switch Sports]]
* [[Splatoon 2]]
* [[Splatoon 3]]
* [[Super Mario Maker 2]]
* [[The Legend of Zelda: Breath of the Wild]] (Nintendo Switch)
|-
| 2.1.4
|
* [[Pokémon Shield]]
* [[Pokémon Sword]]
|-
| 2.1.5
|
* [[Captain Toad: Treasure Tracker]] (Nintendo Switch)
* [[Game Builder Garage]]
* [[Mario Party Superstars]]
* [[Mario Tennis Aces]]
* [[New Super Mario Bros. U Deluxe]]
* [[Nintendo Labo - Toy-Con 01: Variety Kit]]
* [[Nintendo Labo - Toy-Con 02: Robot Kit]]
* [[Nintendo Labo - Toy-Con 03: Vehicle Kit]]
* [[Nintendo Labo - Toy-Con 04: VR Kit]]
* Nintendo Switch System BIOS (3.0.0 – 5.1.0)
* [[Pokémon: Let's Go, Eevee!]]
* [[Pokémon: Let's Go, Pikachu!]]
* [[Splatoon 2]]
* [[Super Mario Odyssey]]
* [[Super Mario Party]]
* [[Sushi Striker: The Way of Sushido]] (Nintendo Switch)
|-
| 2.1.10
|
* Nintendo Switch System BIOS (6.0.0 – 6.2.0)
* [[Tetris 99]]
|-
| 2.1.11
|
* [[Big Brain Academy: Brain vs. Brain]]
* [[Clubhouse Games: 51 Worldwide Classics]]
* [[Dr Kawashima's Brain Training for Nintendo Switch]]
* [[Everybody 1-2-Switch!]]
* [[Mario Golf: Super Rush]]
* [[Momotaro Dentetsu: Showa, Heisei, Reiwa mo Teiban!]]
* Nintendo Switch System BIOS (7.0.0 – 8.1.0)
* [[PAC-MAN 99]]
* [[Pikmin 3 Deluxe]]
* [[Pokémon Legends: Arceus]]
* [[Pokémon Shield]]
* [[Pokémon Sword]]
* [[Ring Fit Adventure]]
* [[Super Kirby Clash]]
* [[Super Mario 3D World + Bowser's Fury]]
* [[Super Mario 3D All-Stars]]
* [[Super Mario Maker 2]]
* [[The Legend Of Zelda: Link's Awakening]]
* [[Tokyo Mirage Sessions ♯FE Encore]]
* [[WarioWare: Get It Together!]]
|-
| 2.1.12
|
* [[Kirby's Dream Buffet]]
* [[Nintendo Switch Sports]]
* [[Pokémon Scarlet]]
* [[Pokémon Violet]]
* [[Splatoon 3]]
* [[WarioWare: Move It!]]
|-
| 2.2.1
|
* [[F-ZERO 99]]
* [[Super Mario Bros. Wonder]]
* [[The Legend of Zelda: Tears of the Kingdom]]
|}

= Tools =
The following tools can handle BNSH files:
* (none)

[[Category:Switch File Formats]]

BNSH (File Format) - Revision history

Atlas: /* Version List */

Atlas: /* Version List */

Atlas: /* Version List */

Atlas: /* Version List */

Atlas: /* Version List */

Wexos: Imported from avsys wiki