XU XUv0.8.8
中文

API

#image

import: #image

counts: 3 fns, 16 methods, 3 types, 0 consts, 0 ifaces

Point / Rectangle / RGBA pixel buffer.

struct Point

XuAPI
pub struct Point {
    pub x int
    pub y int
}

Purpose

Geometry + RGBA buffer aligned with `image` (Point / Rectangle NewRGBA / Set / At). No Color / Image interface: pixels are color.RGBA. Pix is []int of bytes 0..255.

Parameters

x int
value
y int
value

struct Rectangle

XuAPI
pub struct Rectangle {
    pub min Point
    pub max Point
}

Purpose

Public struct `Rectangle`.

Parameters

min Point
minimum
max Point
maximum

struct RGBA

XuAPI
pub struct RGBA {
    pub pix []int
    pub stride int
    pub rect Rectangle
}

Purpose

Public struct `RGBA`.

Parameters

pix []int
field ([]int)
stride int
field (int)
rect Rectangle
field (Rectangle)

pt

XuAPI
pub fn pt(x int, y int) Point

Purpose

Construct a Point.

Parameters

x int
value (int)
y int
value (int)

Returns

Point — a value of this type

rect

XuAPI
pub fn rect(x0 int, y0 int, x1 int, y1 int) Rectangle

Purpose

Construct a Rectangle.

Parameters

x0 int
x0 (int)
y0 int
y0 (int)
x1 int
x1 (int)
y1 int
y1 (int)

Returns

Rectangle — a value of this type

(Point) add

XuAPI
pub fn (p Point) add(q Point) Point

Purpose

Method on `Point`: add.

Parameters

p Point
receiver Point (value receiver)
q Point
q (Point)

Returns

Point — a value of this type

(Point) sub

XuAPI
pub fn (p Point) sub(q Point) Point

Purpose

Method on `Point`: subtract.

Parameters

p Point
receiver Point (value receiver)
q Point
q (Point)

Returns

Point — a value of this type

(Point) eq

XuAPI
pub fn (p Point) eq(q Point) bool

Purpose

Call `eq` on `Point`.

Parameters

p Point
receiver Point (value receiver)
q Point
q (Point)

Returns

bool — true or false

(Point) in_rect

XuAPI
pub fn (p Point) in_rect(r Rectangle) bool

Purpose

Method on `Point`: in rectangle.

Parameters

p Point
receiver Point (value receiver)
r Rectangle
rune (Unicode code point) (Rectangle)

Returns

bool — true or false

(Rectangle) dx

XuAPI
pub fn (r Rectangle) dx() int

Purpose

Call `dx` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)

Returns

int — a value of this type

(Rectangle) dy

XuAPI
pub fn (r Rectangle) dy() int

Purpose

Call `dy` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)

Returns

int — a value of this type

(Rectangle) empty

XuAPI
pub fn (r Rectangle) empty() bool

Purpose

Call `empty` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)

Returns

bool — true or false

(Rectangle) eq

XuAPI
pub fn (r Rectangle) eq(s Rectangle) bool

Purpose

Call `eq` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)
s Rectangle
source string (Rectangle)

Returns

bool — true or false

(Rectangle) overlaps

XuAPI
pub fn (r Rectangle) overlaps(s Rectangle) bool

Purpose

Call `overlaps` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)
s Rectangle
source string (Rectangle)

Returns

bool — true or false

(Rectangle) add

XuAPI
pub fn (r Rectangle) add(p Point) Rectangle

Purpose

Method on `Rectangle`: add.

Parameters

r Rectangle
receiver Rectangle (value receiver)
p Point
p (Point)

Returns

Rectangle — a value of this type

(Rectangle) intersect

XuAPI
pub fn (r Rectangle) intersect(s Rectangle) Rectangle

Purpose

Call `intersect` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)
s Rectangle
source string (Rectangle)

Returns

Rectangle — a value of this type

(Rectangle) union

XuAPI
pub fn (r Rectangle) union(s Rectangle) Rectangle

Purpose

Call `union` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)
s Rectangle
source string (Rectangle)

Returns

Rectangle — a value of this type

(Rectangle) canon

XuAPI
pub fn (r Rectangle) canon() Rectangle

Purpose

Call `canon` on `Rectangle`.

Parameters

r Rectangle
receiver Rectangle (value receiver)

Returns

Rectangle — a value of this type

new_rgba

XuAPI
pub fn new_rgba(r Rectangle) RGBA

Purpose

Construct rgba.

Parameters

r Rectangle
rune (Unicode code point) (Rectangle)

Returns

RGBA — a value of this type

(RGBA) pix_offset

XuAPI
pub fn (p RGBA) pix_offset(x int, y int) int

Purpose

Method on `RGBA`: pix offset.

Parameters

p RGBA
receiver RGBA (value receiver)
x int
value (int)
y int
value (int)

Returns

int — a value of this type

(&mut RGBA) set_rgba

XuAPI
pub fn (p &mut RGBA) set_rgba(x int, y int, c color.RGBA)

Purpose

Method on `&mut RGBA`: set rgba.

Parameters

p &mut RGBA
receiver &mut RGBA (exclusive borrow)
x int
value (int)
y int
value (int)
c color.RGBA
byte or character code (color.RGBA)

(RGBA) at_rgba

XuAPI
pub fn (p RGBA) at_rgba(x int, y int) color.RGBA

Purpose

Method on `RGBA`: at rgba.

Parameters

p RGBA
receiver RGBA (value receiver)
x int
value (int)
y int
value (int)

Returns

color.RGBA — a value of this type