diff --git a/interface/src/ui/Stats.h b/interface/src/ui/Stats.h index f9d53dc29e..00b699c3e6 100644 --- a/interface/src/ui/Stats.h +++ b/interface/src/ui/Stats.h @@ -54,8 +54,8 @@ private: \ * * @property {number} appdropped - The number of times a frame has not been provided to the display device in time. * Read-only. - * @property {number} longsubmits - The number of times the display devices takes longer than 11ms to return after being given - * frame. + * @property {number} longsubmits - The number of times the display device has taken longer than 11ms to return after being + * given a frame. * Read-only. * @property {number} longrenders - The number of times it has taken longer than 11ms to submit a new frame to the display * device. @@ -73,14 +73,12 @@ private: \ * @property {number} refreshRateTarget - The current refresh rate target per the current refreshRateMode and * refreshRateRegime if in desktop mode; a higher rate if in VR mode. * Read-only. - * @property {RefreshRateProfile} refreshRateMode - The current refresh rate profile. * Read-only. * @property {RefreshRateRegime} refreshRateRegime - The current refresh rate regime. * Read-only. * @property {UXMode} uxMode - The user experience (UX) mode that Interface is running in. * Read-only. - * @property {number} avatarCount - The number of avatars in the domain other than the client's. * Read-only. * @property {number} heroAvatarCount - The number avatars in a "hero" zone in the domain, other than the client's. @@ -94,9 +92,8 @@ private: \ * that were updated in the most recent game loop. * Read-only. * @property {number} notUpdatedAvatarCount - The number of avatars in the domain, other than the client's, that weren't able - * to be updated in the most recent game loop because there wasn't enough time. + * to be updated in the most recent game loop because there wasn't enough time to. * Read-only. - * @property {number} packetInCount - The number of packets being received from the domain server, in packets per second. * Read-only. * @property {number} packetOutCount - The number of packets being sent to the domain server, in packets per second. @@ -105,14 +102,12 @@ private: \ * Read-only. * @property {number} mbpsOut - The amount of data being sent to the domain server, in megabits per second. * Read-only. - - * @property {number} assetMbpsIn - The amount of data being received from the asset server, in megabits per second. + @property {number} assetMbpsIn - The amount of data being received from the asset server, in megabits per second. * 0.0 if not connected to an avatar mixer. * Read-only. * @property {number} assetMbpsOut - The amount of data being sent to the asset server, in megabits per second. * 0.0 if not connected to an avatar mixer. * Read-only. - * @property {number} audioPing - The ping time to the audio mixer, in ms. * -1 if not connected to an audio mixer. * Read-only. @@ -128,7 +123,6 @@ private: \ * @property {number} messagePing - The ping time to the message mixer, in ms. * -1 if not connected to a message mixer. * Read-only. - * @property {Vec3} position - The position of the user's avatar. * Read-only. *

Note: Property not available in the API.

@@ -136,7 +130,6 @@ private: \ * Read-only. * @property {number} yaw - The yaw of the user's avatar body, in degrees. * Read-only. - * @property {number} avatarMixerInKbps - The amount of data being received from the avatar mixer, in kilobits per second. * -1 if not connected to an avatar mixer. * Read-only. @@ -149,7 +142,6 @@ private: \ * @property {number} avatarMixerOutPps - The number of packets being sent to the avatar mixer, in packets per second. * -1 if not connected to an avatar mixer. * Read-only. - * @property {number} myAvatarSendRate - The number of avatar packets being sent by the user's avatar, in packets per second. * Read-only. * @@ -169,11 +161,10 @@ private: \ * per second. * -1 if not connected to an audio mixer. * Read-only. - * @property {number} audioMixerPps - The total number of packets being sent to received from the audio mixer, in packets per - * second. + * @property {number} audioMixerPps - The total number of packets being sent to and received from the audio mixer, in packets + * per second. * -1 if not connected to an audio mixer. * Read-only. - * @property {number} audioOutboundPPS - The number of non-silent audio packets being sent by the user, in packets per second. * -1 if not connected to an audio mixer. * Read-only. @@ -189,11 +180,9 @@ private: \ * second. * -1 if not connected to an audio mixer. * Read-only. - * @property {number} audioPacketLoss - The number of audio packets being lost being sent to or received from the audio mixer, - * in %. + * @property {number} audioPacketLoss - The number of audio packets being lost, sent to or received from the audio mixer, in %. * -1 if not connected to an audio mixer. * Read-only. - * @property {string} audioCodec - The name of the audio codec. * Read-only. * @property {string} audioNoiseGate - The status of the audio noise gate: "Open" or "Closed". @@ -201,7 +190,6 @@ private: \ * @property {Vec2} audioInjectors - The number of audio injectors, local and non-local. * Read-only. *

Note: Property not available in the API.

- * @property {number} entityPacketsInKbps - The average amount of data being received from entity servers, in kilobits per * second. (Multiply by the number of entity servers to get the total amount of data being received.) * -1 if not connected to an entity server. @@ -216,12 +204,10 @@ private: \ * @property {string[]} downloadUrls - The download URLs. * Read-only. *

Note: Property not available in the API.

- * @property {number} processing - The number of completed downloads being processed. * Read-only. * @property {number} processingPending - The number of completed downloads waiting to be processed. * Read-only. - * @property {number} triangles - The number of triangles in the rendered scene. * Read-only. * @property {number} drawcalls - The number of draw calls made for the rendered scene. @@ -254,14 +240,12 @@ private: \ * Read-only. * @property {string} lodStatus - Description of the current LOD. * Read-only. - * @property {string} timingStats - Details of the average time (ms) spent in and number of calls made to different parts of * the code. Provided only if timingExpanded is true. Only the top 10 items are provided if * Developer > Timing > Performance Timer > Only Display Top 10 is enabled. * Read-only. * @property {string} gameUpdateStats - Details of the average time (ms) spent in different parts of the game loop. * Read-only. - * @property {number} serverElements - The total number of elements in the server octree. * Read-only. * @property {number} serverInternal - The number of internal elements in the server octree. @@ -274,14 +258,12 @@ private: \ * Read-only. * @property {number} localLeaves - The number of leaf elements in the client octree. * Read-only. - - * @property {number} rectifiedTextureCount - The number of textures that have been resized so that their size is a power of 2 - * if smaller than 128, or a multiple of 128 if greater than 128. + * @property {number} rectifiedTextureCount - The number of textures that have been resized so that their dimensions is a power + * of 2 if smaller than 128 pixels, or a multiple of 128 if greater than 128 pixels. * Read-only. * @property {number} decimatedTextureCount - The number of textures that have been reduced in size because they were over the - * maximum allowed size of 4096 on desktop or 2048 on mobile. + * maximum allowed dimensions of 4096 pixels on desktop or 2048 pixels on mobile. * Read-only. - * @property {number} gpuBuffers - The number of OpenGL buffer objects managed by the GPU back-end. * Read-only. * @property {number} gpuBufferMemory - The total memory size of the gpuBuffers, in MB. @@ -305,8 +287,8 @@ private: \ * Read-only. * @property {number} gpuTextureFramebufferMemory - The memory size of the frame buffer on the GPU, in MB. * Read-only. - * @property {number} gpuTextureResourceMemory - The amount of GPU memory that has been allocated for "variable" textures, in - * MB. + * @property {number} gpuTextureResourceMemory - The amount of GPU memory that has been allocated for "variable" textures that + * don't necessarily always have their full resolution in GPU memory, in MB. * Read-only. * @property {number} gpuTextureResourceIdealMemory - The amount of memory that "variable" textures would take up if they were * all completely loaded, in MB. @@ -317,7 +299,7 @@ private: \ * @property {string} gpuTextureMemoryPressureState - The stats of the texture transfer engine. *