Update doc for mj_addFileVFS and mj_addBufferVFS as VFS is no longer memory limited.

PiperOrigin-RevId: 671087960
Change-Id: I0b022554f4f47fe2e64c8201cd855b63d514c344
This commit is contained in:
Kyle Bayes
2024-09-04 13:50:48 -07:00
committed by Copybara-Service
parent 621ea29382
commit 81618f95f9
4 changed files with 7 additions and 7 deletions
+2 -2
View File
@@ -1231,7 +1231,7 @@ mj_addFileVFS
.. mujoco-include:: mj_addFileVFS
Add file to VFS. The directory argument is optional and can be NULL or empty. Returns 0 on success, 1 when VFS is full,
Add file to VFS. The directory argument is optional and can be NULL or empty. Returns 0 on success,
2 on name collision, or -1 when an internal error occurs.
.. _mj_addBufferVFS:
@@ -1241,7 +1241,7 @@ mj_addBufferVFS
.. mujoco-include:: mj_addBufferVFS
Add file to VFS from buffer, return 0: success, 1: full, 2: repeated name, -1: failed to load.
Add file to VFS from buffer, return 0: success, 2: repeated name, -1: failed to load.
.. _mj_deleteFileVFS:
+1 -1
View File
@@ -20,7 +20,7 @@ Initialize an empty VFS, :ref:`mj_deleteVFS` must be called to deallocate the VF
.. _mj_addFileVFS:
Add file to VFS. The directory argument is optional and can be NULL or empty. Returns 0 on success, 1 when VFS is full,
Add file to VFS. The directory argument is optional and can be NULL or empty. Returns 0 on success,
2 on name collision, or -1 when an internal error occurs.
.. _Parseandcompile:
+2 -2
View File
@@ -77,10 +77,10 @@ MJAPI extern const char* mjRNDSTRING[mjNRNDFLAG][3];
// Initialize an empty VFS, mj_deleteVFS must be called to deallocate the VFS.
MJAPI void mj_defaultVFS(mjVFS* vfs);
// Add file to VFS, return 0: success, 1: full, 2: repeated name, -1: failed to load.
// Add file to VFS, return 0: success, 2: repeated name, -1: failed to load.
MJAPI int mj_addFileVFS(mjVFS* vfs, const char* directory, const char* filename);
// Add file to VFS from buffer, return 0: success, 1: full, 2: repeated name, -1: failed to load.
// Add file to VFS from buffer, return 0: success, 2: repeated name, -1: failed to load.
MJAPI int mj_addBufferVFS(mjVFS* vfs, const char* name, const void* buffer, int nbuffer);
// Delete file from VFS, return 0: success, -1: not found in VFS.
+2 -2
View File
@@ -64,7 +64,7 @@ FUNCTIONS: Mapping[str, FunctionDecl] = dict([
),
),
),
doc='Add file to VFS, return 0: success, 1: full, 2: repeated name, -1: failed to load.', # pylint: disable=line-too-long
doc='Add file to VFS, return 0: success, 2: repeated name, -1: failed to load.', # pylint: disable=line-too-long
)),
('mj_addBufferVFS',
FunctionDecl(
@@ -94,7 +94,7 @@ FUNCTIONS: Mapping[str, FunctionDecl] = dict([
type=ValueType(name='int'),
),
),
doc='Add file to VFS from buffer, return 0: success, 1: full, 2: repeated name, -1: failed to load.', # pylint: disable=line-too-long
doc='Add file to VFS from buffer, return 0: success, 2: repeated name, -1: failed to load.', # pylint: disable=line-too-long
)),
('mj_deleteFileVFS',
FunctionDecl(