Struct x11rb_protocol::protocol::xproto::GC

pub struct GC(/* private fields */);

Fields

• Function - TODO: Refer to GX
• PlaneMask - In graphics operations, given a source and destination pixel, the result is computed bitwise on corresponding bits of the pixels; that is, a Boolean operation is performed in each bit plane. The plane-mask restricts the operation to a subset of planes, so the result is:

((src FUNC dst) AND plane-mask) OR (dst AND (NOT plane-mask))

• Foreground - Foreground colorpixel.
• Background - Background colorpixel.
• LineWidth - The line-width is measured in pixels and can be greater than or equal to one, a wide line, or the special value zero, a thin line.
• LineStyle - The line-style defines which sections of a line are drawn: Solid The full path of the line is drawn. DoubleDash The full path of the line is drawn, but the even dashes are filled differently than the odd dashes (see fill-style), with Butt cap-style used where even and odd dashes meet. OnOffDash Only the even dashes are drawn, and cap-style applies to all internal ends of the individual dashes (except NotLast is treated as Butt).
• CapStyle - The cap-style defines how the endpoints of a path are drawn: NotLast The result is equivalent to Butt, except that for a line-width of zero the final endpoint is not drawn. Butt The result is square at the endpoint (perpendicular to the slope of the line) with no projection beyond. Round The result is a circular arc with its diameter equal to the line-width, centered on the endpoint; it is equivalent to Butt for line-width zero. Projecting The result is square at the end, but the path continues beyond the endpoint for a distance equal to half the line-width; it is equivalent to Butt for line-width zero.
• JoinStyle - The join-style defines how corners are drawn for wide lines: Miter The outer edges of the two lines extend to meet at an angle. However, if the angle is less than 11 degrees, a Bevel join-style is used instead. Round The result is a circular arc with a diameter equal to the line-width, centered on the joinpoint. Bevel The result is Butt endpoint styles, and then the triangular notch is filled.
• FillStyle - The fill-style defines the contents of the source for line, text, and fill requests. For all text and fill requests (for example, PolyText8, PolyText16, PolyFillRectangle, FillPoly, and PolyFillArc) as well as for line requests with line-style Solid, (for example, PolyLine, PolySegment, PolyRectangle, PolyArc) and for the even dashes for line requests with line-style OnOffDash or DoubleDash: Solid Foreground Tiled Tile OpaqueStippled A tile with the same width and height as stipple but with background everywhere stipple has a zero and with foreground everywhere stipple has a one Stippled Foreground masked by stipple For the odd dashes for line requests with line-style DoubleDash: Solid Background Tiled Same as for even dashes OpaqueStippled Same as for even dashes Stippled Background masked by stipple
• FillRule -
• Tile - The tile/stipple represents an infinite two-dimensional plane with the tile/stipple replicated in all dimensions. When that plane is superimposed on the drawable for use in a graphics operation, the upper-left corner of some instance of the tile/stipple is at the coordinates within the drawable specified by the tile/stipple origin. The tile/stipple and clip origins are interpreted relative to the origin of whatever destination drawable is specified in a graphics request. The tile pixmap must have the same root and depth as the gcontext (or a Match error results). The stipple pixmap must have depth one and must have the same root as the gcontext (or a Match error results). For fill-style Stippled (but not fill-style OpaqueStippled), the stipple pattern is tiled in a single plane and acts as an additional clip mask to be ANDed with the clip-mask. Any size pixmap can be used for tiling or stippling, although some sizes may be faster to use than others.
• Stipple - The tile/stipple represents an infinite two-dimensional plane with the tile/stipple replicated in all dimensions. When that plane is superimposed on the drawable for use in a graphics operation, the upper-left corner of some instance of the tile/stipple is at the coordinates within the drawable specified by the tile/stipple origin. The tile/stipple and clip origins are interpreted relative to the origin of whatever destination drawable is specified in a graphics request. The tile pixmap must have the same root and depth as the gcontext (or a Match error results). The stipple pixmap must have depth one and must have the same root as the gcontext (or a Match error results). For fill-style Stippled (but not fill-style OpaqueStippled), the stipple pattern is tiled in a single plane and acts as an additional clip mask to be ANDed with the clip-mask. Any size pixmap can be used for tiling or stippling, although some sizes may be faster to use than others.
• TileStippleOriginX - TODO
• TileStippleOriginY - TODO
• Font - Which font to use for the ImageText8 and ImageText16 requests.
• SubwindowMode - For ClipByChildren, both source and destination windows are additionally clipped by all viewable InputOutput children. For IncludeInferiors, neither source nor destination window is clipped by inferiors. This will result in including subwindow contents in the source and drawing through subwindow boundaries of the destination. The use of IncludeInferiors with a source or destination window of one depth with mapped inferiors of differing depth is not illegal, but the semantics is undefined by the core protocol.
• GraphicsExposures - Whether ExposureEvents should be generated (1) or not (0).

The default is 1.

• ClipOriginX - TODO
• ClipOriginY - TODO
• ClipMask - The clip-mask restricts writes to the destination drawable. Only pixels where the clip-mask has bits set to 1 are drawn. Pixels are not drawn outside the area covered by the clip-mask or where the clip-mask has bits set to 0. The clip-mask affects all graphics requests, but it does not clip sources. The clip-mask origin is interpreted relative to the origin of whatever destination drawable is specified in a graphics request. If a pixmap is specified as the clip-mask, it must have depth 1 and have the same root as the gcontext (or a Match error results). If clip-mask is None, then pixels are always drawn, regardless of the clip origin. The clip-mask can also be set with the SetClipRectangles request.
• DashOffset - TODO
• DashList - TODO
• ArcMode - TODO

Implementations

impl GC

pub const FUNCTION: Self = _

pub const PLANE_MASK: Self = _

pub const FOREGROUND: Self = _

pub const BACKGROUND: Self = _

pub const LINE_WIDTH: Self = _

pub const LINE_STYLE: Self = _

pub const CAP_STYLE: Self = _

pub const JOIN_STYLE: Self = _

pub const FILL_STYLE: Self = _

pub const FILL_RULE: Self = _

pub const TILE: Self = _

pub const STIPPLE: Self = _

pub const TILE_STIPPLE_ORIGIN_X: Self = _

pub const TILE_STIPPLE_ORIGIN_Y: Self = _

pub const FONT: Self = _

pub const SUBWINDOW_MODE: Self = _

pub const GRAPHICS_EXPOSURES: Self = _

pub const CLIP_ORIGIN_X: Self = _

pub const CLIP_ORIGIN_Y: Self = _

pub const CLIP_MASK: Self = _

pub const DASH_OFFSET: Self = _

pub const DASH_LIST: Self = _

pub const ARC_MODE: Self = _

impl GC

pub fn contains(self, flag: impl Into<u32>) -> bool

Check if this object has all bits set that are also set in flag.

flag can be a single enum variant or a whole other mask.

pub fn intersects(self, flag: impl Into<u32>) -> bool

Check if this object has some bits set that are also set in flag.

flag can be a single enum variant or a whole other mask.

pub fn remove(self, flags: impl Into<u32>) -> Self

Remove some flags.

All bits that are set in the given flags are removed from the self instance, if they are present.

pub fn bits(self) -> u32

Returns the internal value of the object.

Trait Implementations

impl BitAnd<GC> for u32

type Output = GC

The resulting type after applying the & operator.

fn bitand(self, other: GC) -> Self::Output

Performs the & operation.

impl BitAnd<u32> for GC

type Output = GC

The resulting type after applying the & operator.

fn bitand(self, other: u32) -> Self::Output

Performs the & operation.

impl BitAnd for GC

type Output = GC

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign<GC> for u32

fn bitand_assign(&mut self, other: GC)

Performs the &= operation.

impl BitAndAssign<u32> for GC

fn bitand_assign(&mut self, other: u32)

Performs the &= operation.

impl BitAndAssign for GC

fn bitand_assign(&mut self, other: GC)

Performs the &= operation.

impl BitOr<GC> for u32

type Output = GC

The resulting type after applying the | operator.

fn bitor(self, other: GC) -> Self::Output

Performs the | operation.

impl BitOr<u32> for GC

type Output = GC

The resulting type after applying the | operator.

fn bitor(self, other: u32) -> Self::Output

Performs the | operation.

impl BitOr for GC

type Output = GC

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<GC> for u32

fn bitor_assign(&mut self, other: GC)

Performs the |= operation.

impl BitOrAssign<u32> for GC

fn bitor_assign(&mut self, other: u32)

Performs the |= operation.

impl BitOrAssign for GC

fn bitor_assign(&mut self, other: GC)

Performs the |= operation.

impl Clone for GC

fn clone(&self) -> GC

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GC

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GC

fn default() -> GC

Returns the “default value” for a type.

impl From<GC> for Option<u32>

fn from(input: GC) -> Self

Converts to this type from the input type.

impl From<GC> for u32

fn from(input: GC) -> Self

Converts to this type from the input type.

impl From<u16> for GC

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for GC

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u8> for GC

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for GC

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GC

fn cmp(&self, other: &GC) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for GC

fn eq(&self, other: &GC) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GC

fn partial_cmp(&self, other: &GC) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for GC

impl Eq for GC

impl StructuralEq for GC

impl StructuralPartialEq for GC