mirrors/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-13 14:32:26 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gg: add missing doc strings to pub fns in image.* (#13934)

Browse source
This commit is contained in:
Larpon 2022-04-05 12:21:03 +02:00 • committed by GitHub
parent 0b046c14a8
commit 2350dbbd57
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
vlib/gg/image.v
View file

@ -19,6 +19,7 @@ pub:
color gx.Color = gx.white
}
// Rect represents a rectangular shape in `gg`.
pub struct Rect {
pub:
x f32
@ -27,6 +28,11 @@ pub:
height f32
}
// cache_image caches the image `img` in memory for later reuse.
// cache_image returns the cache index of the cached image.
//
// See also: get_cached_image_by_idx
// See also: remove_cached_image_by_idx
pub fn (mut ctx Context) cache_image(img Image) int {
ctx.image_cache << img
image_idx := ctx.image_cache.len - 1
@ -34,10 +40,19 @@ pub fn (mut ctx Context) cache_image(img Image) int {
return image_idx
}
// get_cached_image_by_idx returns a cached `Image` identified by `image_idx`.
//
// See also: cache_image
// See also: remove_cached_image_by_idx
pub fn (mut ctx Context) get_cached_image_by_idx(image_idx int) &Image {
return &ctx.image_cache[image_idx]
}
// remove_cached_image_by_idx removes an `Image` identified by `image_idx` from the
// image cache.
//
// See also: cache_image
// See also: get_cached_image_by_idx
pub fn (mut ctx Context) remove_cached_image_by_idx(image_idx int) {
ctx.image_cache.delete(image_idx)
}