MayaTheShy/Starworld
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

fix: update connect method documentation to clarify socketPath behavior

Browse Source
This commit is contained in:
MayaTheShy
2025-11-09 00:00:53 -05:00
parent c67e4172e2
commit 829cd8ccc9
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/StardustBridge.hpp
View File

@@ -17,9 +17,10 @@ public:
using NodeId = std::uint64_t; using NodeId = std::uint64_t;
// Connect to the StardustXR compositor via IPC. // Connect to the StardustXR compositor via IPC.
// Returns true on success. If socketPath is empty, uses defaultSocketPath(). // Returns true on success. Searches standard socket locations if socketPath is empty.
bool connect(const std::string& socketPath = {}); bool connect(const std::string& socketPath = {});
// Create a 3D node with an initial transform. Optionally parent it. // Create a 3D node with an initial transform. Optionally parent it.
NodeId createNode(const std::string& name, NodeId createNode(const std::string& name,
const glm::mat4& transform = glm::mat4(1.0f), const glm::mat4& transform = glm::mat4(1.0f),