Haroon Qureshi
2fd9b5e92f
PiperOrigin-RevId: 862210191 Change-Id: Ia15a345a267bcef4b593d507d54f1668da0c0611
62 lines
2.2 KiB
C
62 lines
2.2 KiB
C
// Copyright 2021 DeepMind Technologies Limited
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
// IWYU pragma: private, include "third_party/mujoco/include/mujoco.h"
|
|
// IWYU pragma: friend "third_party/mujoco/src/.*"
|
|
|
|
#ifndef MUJOCO_SRC_USER_USER_VFS_H_
|
|
#define MUJOCO_SRC_USER_USER_VFS_H_
|
|
|
|
#include <stddef.h>
|
|
|
|
#include <mujoco/mjexport.h>
|
|
#include <mujoco/mjmodel.h>
|
|
#include <mujoco/mjplugin.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
// 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, 2: repeated name, -1: not found on disk
|
|
MJAPI int mj_addFileVFS(mjVFS* vfs, const char* directory, const char* filename);
|
|
|
|
// add file from buffer into VFS, return 0: success, 2: repeated name, -1: failed to load
|
|
MJAPI int mj_addBufferVFS(mjVFS* vfs, const char* filename, const void* buffer, int nbuffer);
|
|
|
|
// mount a ResourceProvider to handle file operations under the given path; return 0: success,
|
|
// 2: repeated name, -1: invalid resource provider
|
|
MJAPI int mj_mountVFS(mjVFS* vfs, const char* filepath, const mjpResourceProvider* provider);
|
|
|
|
// unmount a previously mounted ResourceProvider; return 0: success, -1: not found in VFS
|
|
MJAPI int mj_unmountVFS(mjVFS* vfs, const char* filename);
|
|
|
|
// return file index in VFS, or -1 if not found in VFS
|
|
MJAPI int mj_findFileVFS(const mjVFS* vfs, const char* filename);
|
|
|
|
// delete file from VFS, return 0: success, -1: not found in VFS
|
|
MJAPI int mj_deleteFileVFS(mjVFS* vfs, const char* filename);
|
|
|
|
// delete all files from VFS
|
|
MJAPI void mj_deleteVFS(mjVFS* vfs);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
const mjpResourceProvider* GetVfsResourceProvider();
|
|
|
|
#endif // MUJOCO_SRC_USER_USER_VFS_H_
|