From 5cdeb332b81cf763b7ba813f7053321b5e49bd2c Mon Sep 17 00:00:00 2001 From: NoryiE Date: Tue, 18 Mar 2025 01:06:26 +0000 Subject: [PATCH] deploy: d8d3e6b55552f2a7e23e0a144d82c2e654076902 --- docs/references/plugins/benchmark.md | 2 +- .../benchmark_Container_VisualElement.md | 44 +++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 docs/references/plugins/benchmark_Container_VisualElement.md diff --git a/docs/references/plugins/benchmark.md b/docs/references/plugins/benchmark.md index 108769e..82636ec 100644 --- a/docs/references/plugins/benchmark.md +++ b/docs/references/plugins/benchmark.md @@ -35,7 +35,7 @@ Starts a custom benchmark ### Parameters * `name` `string` The name of the benchmark -* `options` *(optional)* `table` Optional configuration +* `options` *(optional)* `table` Optional configuration ## API.stop(name) Stops a custom benchmark diff --git a/docs/references/plugins/benchmark_Container_VisualElement.md b/docs/references/plugins/benchmark_Container_VisualElement.md new file mode 100644 index 0000000..587ab66 --- /dev/null +++ b/docs/references/plugins/benchmark_Container_VisualElement.md @@ -0,0 +1,44 @@ +# Container : VisualElement + +## Functions + +|Method|Returns|Description| +|---|---|---| +|[Container:benchmarkContainer](#container-benchmarkcontainer)|Container|Recursively enables benchmarking +|[Container:logContainerBenchmarks](#container-logcontainerbenchmarks)|Container|Recursively logs benchmark statistics +|[Container:stopContainerBenchmark](#container-stopcontainerbenchmark)|Container|Recursively stops benchmarking + + +## Container:benchmarkContainer(methodName) +Enables benchmarking for a container and all its children + +### Parameters +* `methodName` `string` The method to benchmark + +### Returns +* `Container` `self` The container instance + +### Usage + ```lua +container:benchmarkContainer("render") +``` + +## Container:logContainerBenchmarks(methodName) +Logs benchmark statistics for a container and all its children + +### Parameters +* `methodName` `string` The method to log + +### Returns +* `Container` `self` The container instance + +## Container:stopContainerBenchmark(methodName) +Stops benchmarking for a container and all its children + +### Parameters +* `methodName` `string` The method to stop benchmarking + +### Returns +* `Container` `self` The container instance + +