MaterialX export from Blender shader nodes #112864

New Issue

Brecht Van Lommel · 2023-09-25T18:45:51+02:00

Brecht Van Lommel commented

2023-09-25 18:45:51 +02:00

As part of Hydra render engine support (#110765 ), we want to be able to render Cycles and EEVEE shaders in Hydra render engines. For this a conversion from Blender shader nodes to MaterialX nodes was implemented in #111765.

This implementation is incomplete, not all nodes are currently supported. This tasks is meant to keep track of the progress. Some nodes may not be possible to export. For this we should add some indicator in the user interface.

Native support for editing MaterialX nodes in Blender is important functionality as well, but not part of the initial implementation.

Tasks

Show which nodes are unsupported when Hydra render engine is selected
Implement Script node (#113341)
Implement White Noise node (#113495)
Implement steps, clamp, smooth step inputs for Map Range node (#114635)
Integrate as part of USD export for
- Hydra
- USD file export

Nodes

Legend

🟢 Implemented
🟡 Partially implemented
🟠 Default value
🔴 Not implemented

Input

Node	Status	Comment
Ambient Occlusion	🟠	MatX node exists but not implemented internally
Attribute	🟠	TODO: could be partially implemented
Bevel	🟠	This node isn't supported by MaterialX
Camera Data	🟠	Returning socket default value
Color Attribute	🟠	TODO: could be partially implemented
Curves Info	🟠	MatX doesn't have an implementation for this node
Fresnel	🟠	TODO: could be partially implemented
Geometry	🟡	Some outputs aren't supported by MaterialX
Layer Weight	🔴
Light Path	🟠	This node isn't supported by MaterialX. Only default values returned.
Object Info	🟡	Some outputs isn't supported by MaterialX
Particle Info	🔴	No correspondent node in MatX
Point Info	🔴	No correspondent node in MatX
RGB	🟢
Tangent	🔴	MatX doesn't have an implementation for this node
Tеxture Coordinate	🟡	Some outputs aren't supported by MaterialX
UV Map	🟡	"""UV"" selection and ""From Instances"" not implemented"
Value	🟢
Volume Info	🔴
Wireframe	🔴	No correspondent node in MatX

Output

Node	Status	Comment
Material Output	🟡	Only Surface input implemented (Volume and Displacement aren't)
Light Output	🔴
AOV Output	🔴

Color

Node	Status	Comment
Brightness/Contrast	🟢
Gamma	🟢
Hue/Saturation/Value	🟢
Invert Color	🟢
Light Falloff	🟢	No correspondent node in MatX. Used formula from OSL shader code in Cycles
Mix Color	🟡	TODO: Apply blend type
RGB Curves	🟠	TODO: could be implemented

Converter

Node	Status	Comment
Blackbody	🟢
Clamp	🟢
Color Ramp	🔴
Combine Color	🟢
Combine XYZ	🟢
Float Curve	🟠	TODO: could be implemented
Map Range	🟢	Smootherstep not supported
Math	🟢
Mix	🟢
RGB to BW	🟢
Separate Color	🟢	MatX doesn't support HSL color model
Separate XYZ	🟢
Vector Math	🟢
Wavelength	🔴

Shader

Node	Status	Comment
Add Shader	🟢
Diffuse BSDF	🟢
Emission	🟢
Glass BSDF	🟢
Glossy BSDF	🟢
Hair BSDF	🔴	No correspondent node in MatX
Holdout	🔴	No correspondent node in MatX
Mix Shader	🟢
Principled BSDF	🟢
Principled Hair BSDF	🔴	No correspondent node in MatX
Principled Volume	🔴	TODO: could be implemented(anisotropic_vdf)
Refraction BSDF	🟢
Sheen BSDF	🟢
Subsurface Scattering	🟢
Toon BSDF	🔴	No correspondent node in MatX
Translucent BSDF	🟢
Transparent BSDF	🟢	"No correspondent node in MatX. It uses ""surface"" node for this purpose but its output is ""surfaceshader""."
Volume Absorption	🔴	TODO: could be implemented (absorption_vdf)
Volume Scatter	🔴	TODO: could be implemented (anisotropic_vdf)

Texture

Node	Status	Comment
Brick Texture	🔴
Checker Texture	🟢
Environment Texture	🟡	texcoords should be translated to spherical coordinates
Gradient Texture	🟢
IES Texture	🔴
Image Texture	🟢	TODO: projection doesn't used
Magic Texture	🔴
Noise Texture	🟡	Some inputs and modes not supported by MaterialX
Point Density	🔴
Sky Texture	🔴
Voronoi Texture	🔴
Wave Texture	🟢
White Noise Texture	🟢

Vector

Node	Status	Comment
Bump	🟢
Displacement	🟢	Normal input and Space feature don't have an implementation in MatX
Mapping	🟢
Normal	🟢
Normal Map	🟢
Vector Curves	🟡	Returning default value. TODO: could be implemented
Vector Displacement	🔴
Vector Rotate	🟢
Vector Transform	🟢

Other

Node	Status	Comment
Script	🔴	TODO: can be implemented to pass mtlx files
NodeGroup	🟢
Frame	🟢
Reroute	🟢

As part of Hydra render engine support (#110765 ), we want to be able to render Cycles and EEVEE shaders in Hydra render engines. For this a conversion from Blender shader nodes to MaterialX nodes was implemented in #111765. This implementation is incomplete, not all nodes are currently supported. This tasks is meant to keep track of the progress. Some nodes may not be possible to export. For this we should add some indicator in the user interface. Native support for editing MaterialX nodes in Blender is important functionality as well, but not part of the initial implementation. ## Tasks * [ ] Show which nodes are unsupported when Hydra render engine is selected * [ ] Implement Script node (https://projects.blender.org/blender/blender/pulls/113341) * [x] Implement White Noise node (https://projects.blender.org/blender/blender/pulls/113495) * [x]Implement `steps`, `clamp`, `smooth step` inputs for Map Range node (https://projects.blender.org/blender/blender/pulls/114635) * [ ] Integrate as part of USD export for * [x] Hydra * [ ] USD file export ## Nodes ### Legend 🟢 Implemented 🟡 Partially implemented 🟠 Default value 🔴 Not implemented ### Input |Node|Status|Comment| |-|-|-| |Ambient Occlusion|🟠|<ambientocclusion> MatX node exists but not implemented internally| |Attribute|🟠|TODO: could be partially implemented| |Bevel|🟠|This node isn't supported by MaterialX| |Camera Data|🟠|Returning socket default value | |Color Attribute|🟠|TODO: could be partially implemented| |Curves Info|🟠|MatX doesn't have an implementation for this node| |Fresnel|🟠|TODO: could be partially implemented| |Geometry|🟡|Some outputs aren't supported by MaterialX| |Layer Weight|🔴|| |Light Path|🟠|This node isn't supported by MaterialX. Only default values returned.| |Object Info|🟡|Some outputs isn't supported by MaterialX| |Particle Info|🔴|No correspondent node in MatX| |Point Info|🔴|No correspondent node in MatX| |RGB|🟢|| |Tangent|🔴|MatX doesn't have an implementation for this node| |Tеxture Coordinate|🟡|Some outputs aren't supported by MaterialX| |UV Map|🟡|"""UV"" selection and ""From Instances"" not implemented"| |Value|🟢|| |Volume Info|🔴|| |Wireframe|🔴|No correspondent node in MatX| ### Output |Node|Status|Comment| |-|-|-| |Material Output|🟡|Only Surface input implemented (Volume and Displacement aren't)| |Light Output|🔴|| |AOV Output|🔴|| ### Color |Node|Status|Comment| |-|-|-| |Brightness/Contrast|🟢|| |Gamma|🟢|| |Hue/Saturation/Value|🟢|| |Invert Color|🟢|| |Light Falloff|🟢|No correspondent node in MatX. Used formula from OSL shader code in Cycles| |Mix Color|🟡|TODO: Apply blend type| |RGB Curves|🟠|TODO: could be implemented| ### Converter |Node|Status|Comment| |-|-|-| |Blackbody|🟢|| |Clamp|🟢|| |Color Ramp|🔴|| |Combine Color|🟢|| |Combine XYZ|🟢|| |Float Curve|🟠|TODO: could be implemented| |Map Range|🟢|Smootherstep not supported| |Math|🟢|| |Mix|🟢|| |RGB to BW|🟢|| |Separate Color|🟢|MatX doesn't support HSL color model| |Separate XYZ|🟢|| |Vector Math|🟢|| |Wavelength|🔴|| ### Shader |Node|Status|Comment| |-|-|-| |Add Shader|🟢|| |Diffuse BSDF|🟢|| |Emission|🟢|| |Glass BSDF|🟢|| |Glossy BSDF|🟢|| |Hair BSDF|🔴|No correspondent node in MatX| |Holdout|🔴|No correspondent node in MatX| |Mix Shader|🟢|| |Principled BSDF|🟢|| |Principled Hair BSDF|🔴|No correspondent node in MatX| |Principled Volume|🔴|TODO: could be implemented(anisotropic_vdf)| |Refraction BSDF|🟢|| |Sheen BSDF|🟢|| |Subsurface Scattering|🟢|| |Toon BSDF|🔴|No correspondent node in MatX| |Translucent BSDF|🟢|| |Transparent BSDF|🟢|"No correspondent node in MatX. It uses ""surface"" node for this purpose but its output is ""surfaceshader""."| |Volume Absorption|🔴|TODO: could be implemented (absorption_vdf)| |Volume Scatter|🔴|TODO: could be implemented (anisotropic_vdf)| ### Texture |Node|Status|Comment| |-|-|-| |Brick Texture|🔴|| |Checker Texture|🟢|| |Environment Texture|🟡|texcoords should be translated to spherical coordinates| |Gradient Texture|🟢|| |IES Texture|🔴|| |Image Texture|🟢|TODO: projection doesn't used| |Magic Texture|🔴|| |Noise Texture|🟡|Some inputs and modes not supported by MaterialX| |Point Density|🔴|| |Sky Texture|🔴|| |Voronoi Texture|🔴|| |Wave Texture|🟢|| |White Noise Texture|🟢|| ### Vector |Node|Status|Comment| |-|-|-| |Bump|🟢|| |Displacement|🟢|Normal input and Space feature don't have an implementation in MatX| |Mapping|🟢|| |Normal|🟢|| |Normal Map|🟢|| |Vector Curves|🟡|Returning default value. TODO: could be implemented| |Vector Displacement|🔴|| |Vector Rotate|🟢|| |Vector Transform|🟢|| ### Other |Node|Status|Comment| |-|-|-| |Script|🔴|TODO: can be implemented to pass mtlx files| |NodeGroup|🟢|| |Frame|🟢|| |Reroute|🟢||

Brecht Van Lommel added the

labels 2023-09-25 18:45:51 +02:00

Brecht Van Lommel referenced this issue

2023-09-25 19:39:23 +02:00

USD Hydra Render Engine #110765

Brecht Van Lommel referenced this issue

2023-09-26 17:46:55 +02:00

Export material to MaterialX for Hydra render #111765

Brecht Van Lommel referenced this issue from a commit

2023-09-26 18:56:05 +02:00

Hydra: export Blender shader nodes as MaterialX node graph

Ashley commented

2023-10-02 08:43:07 +02:00

Re:#111765 (comment), I had a go at trying to add a function to the Python API that allows for writing MaterialX materials to disk and came up with this: https://projects.blender.org/blender/blender/compare/main...expenses:export-materialx. It works pretty well for my needs. Further improvements would be to return a proper MaterialX Python structure instead.

Re:https://projects.blender.org/blender/blender/pulls/111765#issuecomment-1029617, I had a go at trying to add a function to the Python API that allows for writing MaterialX materials to disk and came up with this: https://projects.blender.org/blender/blender/compare/main...expenses:export-materialx. It works pretty well for my needs. Further improvements would be to return a proper MaterialX Python structure instead.

Brecht Van Lommel commented

2023-10-02 11:06:34 +02:00

@expenses that seems useful, could be made into a PR. It should not use hydra::cache_or_get_image_file though since that will write image files to a Hydra cache directory, rather than next to the mtlx files. Probably also would want an option not to write any image files at all.

@expenses that seems useful, could be made into a PR. It should not use `hydra::cache_or_get_image_file` though since that will write image files to a Hydra cache directory, rather than next to the mtlx files. Probably also would want an option not to write any image files at all.

Brecht Van Lommel added this to the Render & Cycles project 2023-10-04 21:24:27 +02:00

Georgiy Markelov referenced this issue

2023-10-09 11:37:05 +02:00

WIP: MaterialX: Implement Script node #113341

Georgiy Markelov referenced this issue

2023-10-10 15:11:37 +02:00

MaterialX: Implement White Noise node #113495

Brecht Van Lommel referenced this issue from a commit

2023-10-23 17:31:53 +02:00

MaterialX: Implement White Noise node

ernest.lee commented

2023-10-27 17:34:03 +02:00

I reviewed https://projects.blender.org/blender/blender/compare/main...expenses:export-materialx and didn't see the usage of hydra::cache_or_get_image_file, what are the next steps to contribute?

I reviewed https://projects.blender.org/blender/blender/compare/main...expenses:export-materialx and didn't see the usage of `hydra::cache_or_get_image_file`, what are the next steps to contribute?

ernest.lee commented

2023-10-27 17:44:51 +02:00

@expenses do you know if it's possible to write a mtlx without external images if they are using them? That seems a feature enhancement to truncate the nodes that uses images.

Brecht Van Lommel referenced this issue from a commit

2023-10-31 18:07:37 +01:00

MaterialX: implement HSV node Factor input

Mr Chocolate Bar commented

2023-11-11 10:51:39 +01:00

Unless its expected that we will be able to export all current and future Eevee/Cycles nodes, it would be neat if we could get some kind of indicator in Blenders UI as to which nodes are supported and not.

It could be either:
a little icon in the nodes "titlebar" (the colored area at the top of each node)
or
some text indicating support status (like "MaterialX: Supported"/"MaterialX: Partial Support"/"MaterialX: Unsupported") when you hover the node).

Unless its expected that we will be able to export all current and future Eevee/Cycles nodes, it would be neat if we could get some kind of indicator in Blenders UI as to which nodes are supported and not. It could be either: a little icon in the nodes "titlebar" (the colored area at the top of each node) or some text indicating support status (like "MaterialX: Supported"/"MaterialX: Partial Support"/"MaterialX: Unsupported") when you hover the node).

Ashley commented

2023-11-12 01:44:50 +01:00

@ernest.lee hey, sorry I don't know MaterialX so well. What I've written works for my use cases but I'm not in a position to polish it to a mergeable state, sorry.

Brecht Van Lommel referenced this issue from a commit

2024-02-05 12:28:32 +01:00

MaterialX: Add remaining float/vector math operations

Antonio commented

2024-04-05 10:23:33 +02:00

Hello,
The noise texture outputs a colored noise at the factro node.

blender/blender-addons#105266

Hello, The noise texture outputs a colored noise at the factro node. blender/blender-addons#105266

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

MaterialX export from Blender shader nodes #112864

Tasks

Nodes

Legend

Input

Output

Color

Converter

Shader

Texture

Vector

Other