mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-09-22 13:45:55 +00:00
Change documentation for callbacks to use Callable[]
This commit is contained in:
@@ -1220,7 +1220,7 @@ The details of the types of messages that can be received are listed under
|
||||
This function will block but only to a limited degree. If no message is waiting after a small time
|
||||
it will return with a No-op message to allow further processing.
|
||||
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value when a long blocking message is coming through, e.g. a capture copy. Can be ``None`` if no
|
||||
progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
@@ -1322,7 +1322,7 @@ separate thread.
|
||||
If this is ``False``, the function will not interact or block forever on user interaction and will
|
||||
always assume the input is effectively 'cancel' or empty. This may cause the symbol resolution to
|
||||
fail.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value for the resolver process. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: The result of the operation.
|
||||
@@ -1511,7 +1511,7 @@ This is primarily useful for when a capture is only stored locally and must be r
|
||||
the capture must be available on the machine where the replay happens.
|
||||
|
||||
:param str filename: The path to the file on the local system.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value for the copy. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: The path on the remote system where the capture was saved temporarily.
|
||||
@@ -1525,7 +1525,7 @@ This function will block until the copy is fully complete, or an error has occur
|
||||
|
||||
:param str remotepath: The remote path where the file should be copied from.
|
||||
:param str localpath: The local path where the file should be saved.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value for the copy. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
)");
|
||||
@@ -1548,7 +1548,7 @@ or an error has occurred.
|
||||
:param str logfile: The path on the remote system where the file is. If the file is only available
|
||||
locally you can use :meth:`CopyCaptureToRemote` to transfer it over the remote connection.
|
||||
:param ReplayOptions opts: The options controlling how the capture should be replayed.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value for the opening. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: A tuple containing the status of opening the capture, whether success or failure, and the
|
||||
@@ -1591,7 +1591,7 @@ empty or unrecognised.
|
||||
|
||||
:param str filename: The filename of the file to open.
|
||||
:param str filetype: The format of the given file.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value if an import step occurs. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: The result of the operation.
|
||||
@@ -1608,7 +1608,7 @@ For the :paramref:`OpenBuffer.filetype` parameter, see :meth:`OpenFile`.
|
||||
|
||||
:param bytes buffer: The buffer containing the data to process.
|
||||
:param str filetype: The format of the given file.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value if an import step occurs. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: The result of the operation.
|
||||
@@ -1642,7 +1642,7 @@ representation back to native RDC.
|
||||
useful in case the format specifies that it doesn't need buffers, and you already have a
|
||||
:class:`ReplayController` open with the structured data. This saves the need to load the file
|
||||
again. If ``None`` then structured data will be fetched if not already present and used.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value for the conversion. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: The result of the operation.
|
||||
@@ -1730,7 +1730,7 @@ Once the replay is created, this :class:`CaptureFile` can be shut down, there is
|
||||
by the :class:`ReplayController`.
|
||||
|
||||
:param ReplayOptions opts: The options controlling how the capture should be replayed.
|
||||
:param ProgressCallback progress: A callback that will be repeatedly called with an updated progress
|
||||
:param Callable[[float], None] progress: A callback that will be repeatedly called with an updated progress
|
||||
value for the opening. Can be ``None`` if no progress is desired.
|
||||
Callback function signature must match :func:`ProgressCallback`.
|
||||
:return: A tuple containing the status of opening the capture, whether success or failure, and the
|
||||
@@ -2019,10 +2019,10 @@ This function will block until a remote connection tells the server to shut down
|
||||
|
||||
:param str listenhost: The name of the interface to listen on.
|
||||
:param int port: The port to listen on, or ``0`` to listen on the default port.
|
||||
:param KillCallback killReplay: A callback that returns a ``bool`` indicating if the server should
|
||||
:param Callable[[], bool] killReplay: A callback that returns a ``bool`` indicating if the server should
|
||||
be shut down or not.
|
||||
Callback function signature must match :func:`KillCallback`.
|
||||
:param PreviewWindowCallback previewWindow: A callback that returns information for a preview window
|
||||
:param Callable[[bool], WindowingData] previewWindow: A callback that returns information for a preview window
|
||||
when the server wants to display some preview of the ongoing replay.
|
||||
Callback function signature must match :func:`PreviewWindowCallback`.
|
||||
)");
|
||||
|
||||
Reference in New Issue
Block a user