Unity-Technologies / Unity-Technologies/NativeRenderingPlugin

No REAL Documentation?

Open
#17 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
943
Forks
186
PR merge metrics
No merged PRs in 30d

Description

Since info provided here and at:

https://docs.unity3d.com/Manual/NativePluginInterface.html

is extremely scarce I started a thread at Unity forum:

https://forum.unity.com/threads/native-plugin-documentation-is-lacking.1220007/

Is IUnityInterface actually meant to be used at any professional capacity or was it meant for enthusiast to try and deduce everything from header files and very simple examples?

At one point in the Vulkan example it says:

// can't use GPU transfer here because is not marked as transfer src

No part of the documentations actually mentions what mode of access is supported by all the different resources in all the APIs (dx11, dx12, vulkan etc). Are people just supposed to experiment and see what won't crash? Is it even possible to access any kind of Debug Layers when working on the plugin to receive any meaningful feedback?

I don't expect any replies but hope this post will help other devs to get an idea of what they are getting into.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Native Plugin Interface documentation and the linked Vulkan example, then review the Unity forum thread for the unanswered questions. The issue covers resource access modes across DX11, DX12, and Vulkan and debug-layer support; it is complete only when those behaviors are documented clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, unity
Domain
computer-graphics, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.