From cc8a559c5307d927ebf32d170bd14004905c599f Mon Sep 17 00:00:00 2001 From: niko Date: Wed, 24 Jul 2024 09:54:32 -0400 Subject: [PATCH] update docs for `Image` and `newImage`, fix #15 --- uing.nim | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/uing.nim b/uing.nim index 497052b..4b18688 100644 --- a/uing.nim +++ b/uing.nim @@ -2701,9 +2701,12 @@ type ## The system will automatically determine the correct image to render depending ## on the screen's pixel density. ## - ## Image only supports premultiplied 32-bit RGBA images. + ## `Image` only supports premultiplied 32-bit RGBA images. ## ## No image file loading or image format conversion utilities are provided. + ## + ## .. important:: `Image` is only a container format for using with tables + ## See libui-ng issue #229: https://github.com/libui-ng/libui-ng/issues/229 genImplProcs(Image) @@ -2736,6 +2739,9 @@ proc newImage*(width, height: float): Image = ## ## :width: Width in points. ## :height: Height in points. + ## + ## .. important:: To reduce confusion, please read the notice in the + ## documentation for `Image`_ newFinal result result.impl = rawui.newImage(width.cdouble, height.cdouble)