Atlas: /* Version List */

2024-10-13T20:49:59Z

Version List

← Older revision		Revision as of 20:49, 13 October 2024
Line 359:		Line 359:
	* [[Super Mario 3D All-Stars]]		* [[Super Mario 3D All-Stars]]
	* [[Super Mario Maker 2]]		* [[Super Mario Maker 2]]
			* [[Super Mario Party Jamboree]]
	* [[The Legend of Zelda: Echoes of Wisdom]]		* [[The Legend of Zelda: Echoes of Wisdom]]
	* [[The Legend Of Zelda: Link's Awakening]]		* [[The Legend Of Zelda: Link's Awakening]]

Atlas: /* Version List */

2024-09-25T21:52:40Z

Version List

← Older revision		Revision as of 21:52, 25 September 2024
Line 359:		Line 359:
	* [[Super Mario 3D All-Stars]]		* [[Super Mario 3D All-Stars]]
	* [[Super Mario Maker 2]]		* [[Super Mario Maker 2]]
			* [[The Legend of Zelda: Echoes of Wisdom]]
	* [[The Legend Of Zelda: Link's Awakening]]		* [[The Legend Of Zelda: Link's Awakening]]
	* [[WarioWare: Get It Together!]]		* [[WarioWare: Get It Together!]]

Atlas: /* Version List */

2024-07-17T20:20:37Z

Version List

← Older revision		Revision as of 20:20, 17 July 2024
Line 350:		Line 350:
	* [[Nintendo Switch Sports]]		* [[Nintendo Switch Sports]]
	* Nintendo Switch System BIOS (7.0.0 – 8.1.0)		* Nintendo Switch System BIOS (7.0.0 – 8.1.0)
			* [[Nintendo World Championships: NES Edition]]
	* [[PAC-MAN 99]]		* [[PAC-MAN 99]]
	* [[Paper Mario: The Origami King]]		* [[Paper Mario: The Origami King]]

Atlas: /* Version List */

2024-05-23T14:57:37Z

Version List

← Older revision		Revision as of 14:57, 23 May 2024
Line 352:		Line 352:
	* [[PAC-MAN 99]]		* [[PAC-MAN 99]]
	* [[Paper Mario: The Origami King]]		* [[Paper Mario: The Origami King]]
			* [[Paper Mario: The Thousand-Year Door]] (Nintendo Switch)
	* [[Ring Fit Adventure]]		* [[Ring Fit Adventure]]
	* [[Super Kirby Clash]]		* [[Super Kirby Clash]]

Wexos: Imported from avsys wiki

2024-05-01T17:10:30Z

Imported from avsys wiki

New page

{{under-construction}}
'''BFSHA''' ('''B'''inary ca'''F'''e '''SH'''ader '''A'''rchive) is a shader file format used on the [[Nintendo Switch]]. It is an archive of shaders, and can store multiple shaders, plus its shader variations, allowing usage of generic uber shaders. It is used for rendering [[BFRES (File Format)/Switch|BFRES]] files, and therefore usually stored as an external into an BFRES.

= File Format =
== Header ==
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Char[8] || '''File magic'''. Always ''FSHA '' in ASCII, or 46 53 48 41 20 20 20 20.
|-
| 0x08 || UInt32 || '''[[#Version List|Version Number]]'''.
|-
| 0x0C || UInt16 || {{BOM}}
|-
| 0x0E || Byte || '''Alignment shift'''. 2 raised by this value is the alignment required by this file when loaded into memory.
|-
| 0x0F || Byte || '''Target address size'''. Size of a pointer in bits. Never set and there remains 0.
|-
| 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 || Int64 || '''[[#Shader Archive|Shader archive]] offset'''.
|-
| 0x28 || Int64 || '''[[#String Table|String table]] offset'''.
|-
| 0x30 || UInt32 || '''Size of [[#String Table|string table]]''' in bytes.
|-
| 0x34 || Byte[4] || '''Padding'''.
|}

=== String Table ===
{{NX String Table}}
=== Dictionary ===
{{NX Dictionary}}
=== Relocation Table ===
{{NX Relocation Table}}
== Shader Archive ==
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Shader archive name offset'''.
|-
| 0x08 || Int64 || '''Original path offset'''.
|-
| 0x10 || Int64 || '''[[#Shading Model|Shading model]] array offset'''.
|-
| 0x18 || Int64 || '''[[#Shading Model|Shading model]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x20 || Int64 || '''User pointer''', set on runtime.
|-
| 0x28 || Int64 || '''Callback pointer''', set on runtime.
|-
| 0x30 || Int64 || '''Work memory pointer''', set on runtime.
|-
| 0x38 || UInt16 || '''Number of [[#Shading Model|shading models]]'''.
|-
| 0x3A || UInt16 || '''Flag'''. xxxx xxxx '''ABCD E'''x'''FG'''.
* '''A''': Shader archive initialized.
* '''B''': Intermediate shader source is available.
* '''C''': Shader offline DL.
* '''D''': Force variation. The option is forced to be changed.
* '''E''': Binary shader source is available.
* '''F''': Binary shader source.
* '''G''': Has shader source.
|-
| 0x3C || Byte[4] || '''Paddding'''.
|}

=== Shading Model ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Shading model name offset'''.
|-
| 0x08 || Int64 || '''Static [[#Shader Option|shader option]] array offset'''.
|-
| 0x10 || Int64 || '''Static [[#Shader Option|shader option]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x18 || Int64 || '''Dynamic [[#Shader Option|shader option]] array offset'''.
|-
| 0x20 || Int64 || '''Dynamic [[#Shader Option|shader option]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x28 || Int64 || '''[[#Attribute Variable|Attribute variable]] array offset'''.
|-
| 0x30 || Int64 || '''[[#Attribute Variable|Attribute variable]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x38 || Int64 || '''[[#Sampler Variable|Sampler variable]] array offset'''.
|-
| 0x40 || Int64 || '''[[#Sampler Variable|Sampler variable]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x48 || Int64 || '''[[#Uniform Block Variable|Uniform block variable]] array offset'''.
|-
| 0x50 || Int64 || '''[[#Uniform Block Variable|Uniform block variable]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x58 || Int64 || '''[[#Uniform Variable|Uniform variable]] array offset'''.
|-
| 0x60 || Int64 || '''[[#Shader Program|Shader program]] array offset'''.
|-
| 0x68 || Int64 || '''Key table offset'''. Points to an array of UInt32s. The count is the same as the number of shader programs.
|-
| 0x70 || Int64 || '''Owning [[#Shader Archive|shader archive]] offset'''.
|-
| 0x78 || Int64 || '''[[#Shader Info|Shader info]] offset'''.
|-
| 0x80 || Int64 || '''[[BNSH (File Format)|BNSH]] offset'''.
|-
| 0x88 || Int64 || '''Mutex type offset''', set on runtime.
|-
| 0x90 || Int64 || '''User pointer''', set on runtime.
|-
| 0x98 || Int64 || '''Call back parameter pointer''', set on runtime.
|-
| 0xA0 || Int32 || '''Number of [[#Uniform Variable|uniform variables]]'''.
|-
| 0xA4 || Int32 || '''Default program index'''.
|-
| 0xA8 || UInt16 || '''Number of static [[#Shader Option|shader options]]'''.
|-
| 0xAA || UInt16 || '''Number of dynamic [[#Shader Option|shader options]]'''.
|-
| 0xAC || UInt16 || '''Number of [[#Shader Program|shader programs]]'''.
|-
| 0xAE || UInt16 || '''Max geometry shader ring buffer output'''. Maximum number of vertex data output from the geometry shader to the ring buffer.
|-
| 0xB0 || Byte || '''Static key length'''.
|-
| 0xB1 || Byte || '''Dynamic key length'''.
|-
| 0xB2 || Byte || '''Number of [[#Attribute Variable|attribute variables]]'''.
|-
| 0xB3 || Byte || '''Number of [[#Sampler Variable|sampler variables]]'''.
|-
| 0xB4 || Byte || '''Number of [[#Uniform Block Variable|uniform block variables]]'''.
|-
| 0xB5 || Byte || '''Max vertex shader ring buffer output'''. Maximum number of vertex data output from the vertex shader to the ring buffer.
|-
| 0xB6 || Byte[4] || '''System block indices'''. Specifies block indices for material, shape, skeleton and shader options.
|-
| 0xBA || Byte[6] || '''Padding'''.
|}

==== Shader Option ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Name offset'''. Points to the name of this shader option.
|-
| 0x08 || Int64 || '''Choice [[#Dictionary|dictionary]] offset'''.
|-
| 0x10 || Int64 || '''Choice value array offset'''. Points to an array of UInt32s.
|-
| 0x18 || Byte || '''Number of choices.
|-
| 0x19 || Byte || '''Default index'''.
|-
| 0x1A || UInt16 || '''Branch offset'''. Offset into the [[#Uniform Block Variable|uniform block variable]].
|-
| 0x1C || Byte || '''Flag'''. xxxx xx'''AB'''.
* '''A''': Branch.
* '''B''': Static.
|-
| 0x1D || Byte || '''Key offset'''. 0 for static option, ''static key length'' for dynamic option.
|-
| 0x1E || Byte || {{Unknown-left|'''Index'''.}}
|-
| 0x1F || Byte || {{Unknown-left|'''Shift'''.}}
|-
| 0x20 || Int32 || {{Unknown-left|'''Mask'''.}}
|-
| 0x24 || Byte[4] || '''Padding'''.
|}

==== Attribute Variable ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Byte || '''[[#Shading Model|Shading model]] index'''.
|-
| 0x01 || Byte || '''Shader location'''.
|}

==== Sampler Variable ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Alt name offset'''.
|-
| 0x08 || Byte || '''Index'''. Index into the shader.
|-
| 0x09 || Byte[7] || '''Padding'''.
|}

==== Uniform Block Variable ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''[[#Uniform Variable|Uniform variable]] array offset'''.
|-
| 0x08 || Int64 || '''[[#Uniform Variable|Uniform variable]] [[#Dictionary|dictionary]] offset'''.
|-
| 0x10 || Int64 || '''Default value offset'''. Only exists for type material.
|-
| 0x18 || Byte || '''Shading model index'''.
|-
| 0x19 || Byte || '''Type'''.
{| class="wikitable"
! ID !! Name
|-
| 0x00 || None
|-
| 0x01 || Material
|-
| 0x02 || Shape
|-
| 0x03 || Skeleton
|-
| 0x04 || Shader option
|}
|-
| 0x1A || UInt16 || '''Size of this uniform block''' in bytes.
|-
| 0x1C || UInt16 || '''Number of [[#Uniform Variable|uniform variables]]'''.
|-
| 0x1E || Byte[2] || '''Padding'''.
|}

==== Uniform Variable ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Conversion function name offest'''.
|-
| 0x08 || Int32 || '''Index into the shader'''.
|-
| 0x0C || UInt16 || '''Data offset''', relative to the start of the owning [[#Uniform Block Variable|uniform block variable]].
|-
| 0x0E || Byte || '''Owning [[#Uniform Block Variable|uniform block variable]] index'''.
|-
| 0x0F || Byte || '''Padding'''.
|}

==== Shader Program ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Sampler table offset'''. Points to an array of Int32s.
|-
| 0x08 || Int64 || '''Uniform block table'''. Points to an array of Int32s.
|-
| 0x10 || Int64 || '''[[#Shader Variation|Shader variation]] offset'''.
|-
| 0x18 || Int64 || '''Owning [[#Shading Model|shading model]] offset'''.
|-
| 0x20 || UInt32 || '''Attribute active flag'''.
|-
| 0x24 || UInt16 || '''Flag'''. xxxx xxxx xxx''''A BCDE'''.
* '''A''': Intermediate language.
* '''B''': Source.
* '''C''': Binary.
* '''D''': Initialized.
* '''E''': Update required.
|-
| 0x26 || UInt16 || '''Number of samplers'''.
|-
| 0x28 || UInt16 || '''Number of uniform blocks'''.
|-
| 0x2A || Byte[6] || '''Padding'''.
|}

===== Shader Variation =====

==== Shader Info ====
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int64 || '''Sampler table offset'''.
|-
| 0x08 || Int64 || '''Uniform block table offset'''.
|-
| 0x10 || Int64 || '''Streamout offset'''.
|-
| 0x18 || UInt32 || '''Number of streamouts'''.
|-
| 0x1C || Byte[4] || '''Padding'''.
|}

= Version List =
{|class="wikitable"
! Version !! Found in
|-
| 3.0.1
|
* [[1-2-Switch]]
* [[ARMS]]
* [[Mario Kart 8 Deluxe]]
* [[Mario Kart 8 Deluxe]] (S00018080-R00018076-A00000000 Prototype)
* Nintendo Switch System BIOS (1.0.0)
* [[The Legend of Zelda: Breath of the Wild]] (Nintendo Switch)
|-
| 5.0.0
|
* Nintendo Switch System BIOS (2.1.0 – 2.3.0)
|-
| 7.0.0
|
* [[Captain Toad: Treasure Tracker]] (Nintendo Switch)
* [[Game Builder Garage]]
* [[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)
* [[Pikmin 3 Deluxe]]
* [[Splatoon 2]]
* [[Super Mario Party]]
* [[Super Mario Odyssey]]
* [[Sushi Striker: The Way of Sushido]] (Nintendo Switch)
|-
| 7.0.2
|
* Nintendo Switch System BIOS (6.0.0 – 6.2.0)
|-
| 7.0.3
|
* [[Tetris 99]]
|-
| 8.0.0
|
* [[Animal Crossing: New Horizons]]
* [[Big Brain Academy: Brain vs. Brain]]
* [[Clubhouse Games: 51 Worldwide Classics]]
* [[Dr Kawashima's Brain Training for Nintendo Switch]]
* [[Everybody 1-2-Switch!]]
* [[F-ZERO 99]]
* [[Kirby's Dream Buffet]]
* [[Kirby and the Forgotten Land]]
* [[Kirby Fighters 2]]
* [[Mario Golf: Super Rush]]
* [[Mario Party Superstars]]
* [[Momotaro Dentetsu: Showa, Heisei, Reiwa mo Teiban!]]
* [[Nintendo Switch Sports]]
* Nintendo Switch System BIOS (7.0.0 – 8.1.0)
* [[PAC-MAN 99]]
* [[Paper Mario: The Origami King]]
* [[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]]
* [[WarioWare: Get It Together!]]
* [[WarioWare: Move It!]]
|-
| 9.0.0
|
* [[Splatoon 3]]
* [[Super Mario Bros. Wonder]]
* [[The Legend of Zelda: Tears of the Kingdom]]
|}

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

[[Category:Switch File Formats]]

BFSHA (File Format) - Revision history

Atlas: /* Version List */

Atlas: /* Version List */

Atlas: /* Version List */

Atlas: /* Version List */

Wexos: Imported from avsys wiki