Skip to content

Commit b4ea87e

Browse files
committed
Added edits to the FBX SDK C# Bindings package, including trademarks
1 parent 3a96de0 commit b4ea87e

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

Packages/com.autodesk.fbx/Documentation~/com.autodesk.fbx.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# About the FBX SDK C# Bindings package
1+
# FBX SDK C# Bindings
22

33
__Version__: 2.0.0-preview
44

5-
The FBX SDK C# Bindings provide access from Unity C# scripts to a subset of the Autodesk FBX SDK, version 2018.1.
5+
The FBX SDK C# Bindings package provides access to a subset of the Autodesk® FBX® SDK, version 2018.1 from Unity C# scripts.
66

7-
The Autodesk® FBX® SDK is a free, easy-to-use, C++ software development platform and API toolkit that allows application and content vendors to transfer existing content into the FBX format with minimal effort.
7+
The Autodesk® FBX® SDK is a C++ software development platform and API toolkit that is free and easy-to-use. It allows application and content vendors to transfer existing content into the FBX format with minimal effort.
88

9-
The FBX SDK C# Bindings support the FBX Exporters package. The subset or the API that is exposed is geared towards exporting; import is not guaranteed to be possible yet.
9+
> ***Note:*** The FBX SDK C# Bindings package exposes only a subset of the API. That subset enables exporter tools, such as the [FBX Exporter](https://docs.unity3d.com/Packages/com.autodesk.fbx@latest) package. Using the FBX SDK C# Bindings package for importing is not recommended. See [Known issues](#issues) below for more information.
1010
1111
## Requirements
1212

@@ -21,15 +21,25 @@ The FBX SDK C# Bindings package contains:
2121
* C# bindings
2222
* Compiled binaries for MacOS and Windows that include the FBX SDK
2323

24-
## Known Issues
24+
## Known issues
2525

26-
* In this version, you cannot downcast the C# objects, which limits the use of the bindings for an importer. For example, if the FBX SDK declares in C++ that it will return an FbxDeformer, on the C++ side if you happen to know it is in fact an FbxSkinDeformer you could safely cast the deformer to a skin deformer. However, on the C# side, this is not permitted.
27-
* While there are guards against some common errors, it is possible to crash Unity by writing C# code that directs the FBX SDK to perform invalid operations. For example, if you have an FbxProperty in C# and you delete the FbxNode that contains the property, if you try to use the FbxProperty, that will have undefined behaviour which may include crashing the Unity Editor. Make sure to read the editor log if you have unexplained crashes when writing FBX SDK C# code.
28-
* The FBX SDK C# Bindings package is not supported if you build using the IL2CPP backend.
26+
### Importing
2927

30-
## API Documentation
28+
In this version, you cannot downcast the C# objects, which limits the use of the bindings for an importer. For example, if the FBX SDK declares in C++ that it will return an `FbxDeformer`, you could safely cast the deformer to a skin deformer on the C++ side if you happen to know it is an `FbxSkinDeformer`. However, on the C# side, this is not permitted.
3129

32-
There is no API documentation in the preview package. Refer to the <a href="http://help.autodesk.com/view/FBX/2018/ENU/">Autodesk FBX SDK API documentation</a>.
30+
### Invalid operations
31+
32+
While there are guards against some common errors, it is possible to crash Unity by writing C# code that directs the FBX SDK to perform invalid operations. For example, if you have an `FbxProperty` in C# and you delete the `FbxNode` that contains the property, using the `FbxProperty` may produce undefined behavior This may even include crashing the Unity Editor. Make sure to read the editor log if you have unexplained crashes when writing FBX SDK C# code.
33+
34+
### IL2CPP backend
35+
36+
The FBX SDK C# Bindings package is not supported if you build using the IL2CPP backend.
37+
38+
39+
40+
## API documentation
41+
42+
There is no API documentation in the preview package. See the <a href="http://help.autodesk.com/cloudhelp/2018/ENU/FBX-Developer-Help/cpp_ref/annotated.html">Autodesk® FBX® SDK API documentation</a>.
3343

3444
The bindings are in the `Autodesk.Fbx` namespace:
3545

0 commit comments

Comments
 (0)