var searchIndex = {}; searchIndex["remotery"] = {"doc":"Remotery is a realtime CPU/GPU profiler with a viewer that runs in a web browser.\nThis lib is a [Rust](https://www.rust-lang.org) wrapper around the C API provided by Remotery and the original\nrepo over here https://github.com/Celtoys/Remotery","items":[[3,"Remotery","remotery","Holds the main instance for Remotery",null,null],[3,"RemoteryScope","","Scopes allows you to profile a bit of code and the end_cpu_sample will be called once it goes out of scope",null,null],[4,"SampleFlags","","Sample flags to decide how profiling info should be handled",null,null],[13,"Default","","Default behaviour",0,null],[13,"Aggregate","","Search parent for same-named samples and merge timing instead of adding a new sample",0,null],[0,"error","","",null,null],[4,"RemoteryError","remotery::error","",null,null],[13,"Malloc","","Malloc call within remotery failed",1,null],[13,"TlsAllocFail","","Attempt to allocate thread local storage failed",1,null],[13,"VirtualMemoryBufferFail","","Failed to create a virtual memory mirror buffer",1,null],[13,"CreateThreadFail","","Failed to create a thread for the server",1,null],[13,"SocketInitNetworkFail","","Network initialisation failure (e.g. on Win32, WSAStartup fails)",1,null],[13,"SocketCreateFail","","Can't create a socket for connection to the remote viewer",1,null],[13,"SocketBindFail","","Can't bind a socket for the server",1,null],[13,"SocketListenFail","","Created server socket failed to enter a listen state",1,null],[13,"SocketSetNonBlockingFail","","Created server socket failed to switch to a non-blocking state",1,null],[13,"SocketInvalidPoll","","Poll attempt on an invalid socket",1,null],[13,"SocketSelectFail","","Server failed to call select on socket",1,null],[13,"SocketPollErrors","","Poll notified that the socket has errors",1,null],[13,"SocketAcceptFail","","Server failed to accept connection from client",1,null],[13,"SocketSendTimeout","","Timed out trying to send data",1,null],[13,"SocketSendFail","","Unrecoverable error occured while client/server tried to send data",1,null],[13,"SocketRecvNoData","","No data available when attempting a receive",1,null],[13,"SocketRecvTimeout","","Timed out trying to receive data",1,null],[13,"SocketRecvFailed","","Unrecoverable error occured while client/server tried to receive data",1,null],[13,"WebsocketHandshakeNotGet","","WebSocket server handshake failed, not HTTP GET",1,null],[13,"WebsocketHandshakeNoVersion","","WebSocket server handshake failed, can't locate WebSocket version",1,null],[13,"WebsocketHandshakeBadVersion","","WebSocket server handshake failed, unsupported WebSocket version",1,null],[13,"WebsocketHandshakeNoHost","","WebSocket server handshake failed, can't locate host",1,null],[13,"WebsocketHandshakeBadHost","","WebSocket server handshake failed, host is not allowed to connect",1,null],[13,"WebsocketHandshakeNoKey","","WebSocket server handshake failed, can't locate WebSocket key",1,null],[13,"WebsocketHandshakeBadKey","","WebSocket server handshake failed, WebSocket key is ill-formed",1,null],[13,"WebsocketHandshakeStringFail","","WebSocket server handshake failed, internal error, bad string code",1,null],[13,"WebsocketDisconnected","","WebSocket server received a disconnect request and closed the socket",1,null],[13,"WebsocketBadFrameHeader","","Couldn't parse WebSocket frame header",1,null],[13,"WebsocketBadFrameHeaderSize","","Partially received wide frame header size",1,null],[13,"WebsocketBadFrameHeaderMask","","Partially received frame header data mask",1,null],[13,"WebsocketReceiveTimeout","","Timeout receiving frame header",1,null],[13,"RemoteryNotCreated","","Remotery object has not been created",1,null],[13,"SendOnIncompleteProfile","","An attempt was made to send an incomplete profile tree to the client",1,null],[13,"CudaDeinitialized","","This indicates that the CUDA driver is in the process of shutting down",1,null],[13,"CudaNotInitialized","","This indicates that the CUDA driver has not been initialized with cuInit() or that initialization has failed",1,null],[13,"CudaInvalidContext","","This most frequently indicates that there is no context bound to the current thread",1,null],[13,"CudaInvalidValue","","This indicates that one or more of the parameters passed to the API call is not within an acceptable range of values",1,null],[13,"CudaInvalidHandle","","This indicates that a resource handle passed to the API call was not valid",1,null],[13,"CudaOutofMemory","","The API call failed because it was unable to allocate enough memory to perform the requested operation",1,null],[13,"ErrorNotReady","","This indicates that a resource handle passed to the API call was not valid",1,null],[13,"D3d11FailedToCreateQuery","","Failed to create query for sample",1,null],[13,"OpenglError","","Generic OpenGL error, no real need to expose more detail since app will probably have an OpenGL error callback registered",1,null],[13,"Unknown","","Unknown error",1,null],[5,"get_error","","",null,{"inputs":[{"name":"u32"}],"output":{"name":"remoteryerror"}}],[11,"clone","","",1,null],[11,"fmt","","",1,null],[11,"fmt","","",1,null],[11,"description","","",1,null],[11,"clone","remotery","",0,null],[11,"create_global_instance","","Creates the global instance (with in the C lib that this code wraps) this code needs to be\ncalled before any of the other code is being called and the instance will be dropped when\nit goes out of scope so it's suggested to call this early in the main entry point of your\nprogram (such as ``main``)",2,{"inputs":[],"output":{"name":"result"}}],[11,"begin_cpu_sample","","",2,{"inputs":[{"name":"str"},{"name":"sampleflags"}],"output":null}],[11,"end_cpu_sample","","Ends a cpu sample. Notice that this needs to be paired with ``begin_cpu_sample`` as seen above.",2,{"inputs":[],"output":null}],[11,"set_current_thread_name","","Setts the name of the current thread that makes it easier to identify it in the Remotery UI",2,{"inputs":[{"name":"str"}],"output":null}],[11,"log_text","","",2,{"inputs":[{"name":"str"}],"output":null}],[11,"new","","",3,{"inputs":[{"name":"str"},{"name":"sampleflags"}],"output":{"name":"remoteryscope"}}],[11,"drop","","",3,null],[11,"drop","","",2,null]],"paths":[[4,"SampleFlags"],[4,"RemoteryError"],[3,"Remotery"],[3,"RemoteryScope"]]}; initSearch(searchIndex);