| | |
- builtins.int(builtins.object)
-
- RgbPrimitive
- builtins.tuple(builtins.object)
-
- Rgb
class Rgb(builtins.tuple) |
| |
Rgb(red: svgen.color.rgb.RgbPrimitive, green: svgen.color.rgb.RgbPrimitive, blue: svgen.color.rgb.RgbPrimitive, alpha: svgen.color.alpha.Alpha = 1.0)
A definition of an rgb color.
|
| |
- Method resolution order:
- Rgb
- builtins.tuple
- builtins.object
Methods defined here:
- __getnewargs__(self)
- Return self as a plain tuple. Used by copy and pickle.
- __repr__(self)
- Return a nicely formatted representation string
- __str__(self) -> str
- Get this color as a hex string.
- _asdict(self)
- Return a new dict which maps field names to their values.
- _replace(self, /, **kwds)
- Return a new Rgb object replacing specified fields with new values
Class methods defined here:
- _make(iterable) from builtins.type
- Make a new Rgb object from a sequence or iterable
Static methods defined here:
- __new__(_cls, red: svgen.color.rgb.RgbPrimitive, green: svgen.color.rgb.RgbPrimitive, blue: svgen.color.rgb.RgbPrimitive, alpha: svgen.color.alpha.Alpha = 1.0)
- Create new instance of Rgb(red, green, blue, alpha)
- from_ctor(value: str) -> 'Rgb'
- Get an rgb color from a constructor string.
- from_hex(value: str) -> 'Rgb'
- Get an rgb color from a hex string.
Readonly properties defined here:
- rgb
- Get this color as an 'rgb' constructor.
- rgba
- Get this color as an 'rgba' constructor.
Data descriptors defined here:
- red
- Alias for field number 0
- green
- Alias for field number 1
- blue
- Alias for field number 2
- alpha
- Alias for field number 3
Data and other attributes defined here:
- __annotations__ = {'alpha': <class 'svgen.color.alpha.Alpha'>, 'blue': <class 'svgen.color.rgb.RgbPrimitive'>, 'green': <class 'svgen.color.rgb.RgbPrimitive'>, 'red': <class 'svgen.color.rgb.RgbPrimitive'>}
- __match_args__ = ('red', 'green', 'blue', 'alpha')
- __orig_bases__ = (<function NamedTuple>,)
- _field_defaults = {'alpha': 1.0}
- _fields = ('red', 'green', 'blue', 'alpha')
Methods inherited from builtins.tuple:
- __add__(self, value, /)
- Return self+value.
- __contains__(self, key, /)
- Return bool(key in self).
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __getitem__(self, key, /)
- Return self[key].
- __gt__(self, value, /)
- Return self>value.
- __hash__(self, /)
- Return hash(self).
- __iter__(self, /)
- Implement iter(self).
- __le__(self, value, /)
- Return self<=value.
- __len__(self, /)
- Return len(self).
- __lt__(self, value, /)
- Return self<value.
- __mul__(self, value, /)
- Return self*value.
- __ne__(self, value, /)
- Return self!=value.
- __rmul__(self, value, /)
- Return value*self.
- count(self, value, /)
- Return number of occurrences of value.
- index(self, value, start=0, stop=9223372036854775807, /)
- Return first index of value.
Raises ValueError if the value is not present.
Class methods inherited from builtins.tuple:
- __class_getitem__(...) from builtins.type
- See PEP 585
|
class RgbPrimitive(builtins.int) |
| |
RgbPrimitive(val: int) -> 'RgbPrimitive'
An integer type for rgb values.
|
| |
- Method resolution order:
- RgbPrimitive
- builtins.int
- builtins.object
Methods defined here:
- __str__(self) -> str
- Get this color value as a hex string.
Static methods defined here:
- __new__(cls, val: int) -> 'RgbPrimitive'
- Create a new primitive value for an rgb color.
Readonly properties defined here:
- ratio
- Get this color as a ratio between 0 and 1.
Data descriptors defined here:
- __dict__
- dictionary for instance variables
Methods inherited from builtins.int:
- __abs__(self, /)
- abs(self)
- __add__(self, value, /)
- Return self+value.
- __and__(self, value, /)
- Return self&value.
- __bool__(self, /)
- True if self else False
- __ceil__(...)
- Ceiling of an Integral returns itself.
- __divmod__(self, value, /)
- Return divmod(self, value).
- __eq__(self, value, /)
- Return self==value.
- __float__(self, /)
- float(self)
- __floor__(...)
- Flooring an Integral returns itself.
- __floordiv__(self, value, /)
- Return self//value.
- __format__(self, format_spec, /)
- Convert to a string according to format_spec.
- __ge__(self, value, /)
- Return self>=value.
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __getnewargs__(self, /)
- __gt__(self, value, /)
- Return self>value.
- __hash__(self, /)
- Return hash(self).
- __index__(self, /)
- Return self converted to an integer, if self is suitable for use as an index into a list.
- __int__(self, /)
- int(self)
- __invert__(self, /)
- ~self
- __le__(self, value, /)
- Return self<=value.
- __lshift__(self, value, /)
- Return self<<value.
- __lt__(self, value, /)
- Return self<value.
- __mod__(self, value, /)
- Return self%value.
- __mul__(self, value, /)
- Return self*value.
- __ne__(self, value, /)
- Return self!=value.
- __neg__(self, /)
- -self
- __or__(self, value, /)
- Return self|value.
- __pos__(self, /)
- +self
- __pow__(self, value, mod=None, /)
- Return pow(self, value, mod).
- __radd__(self, value, /)
- Return value+self.
- __rand__(self, value, /)
- Return value&self.
- __rdivmod__(self, value, /)
- Return divmod(value, self).
- __repr__(self, /)
- Return repr(self).
- __rfloordiv__(self, value, /)
- Return value//self.
- __rlshift__(self, value, /)
- Return value<<self.
- __rmod__(self, value, /)
- Return value%self.
- __rmul__(self, value, /)
- Return value*self.
- __ror__(self, value, /)
- Return value|self.
- __round__(...)
- Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
- __rpow__(self, value, mod=None, /)
- Return pow(value, self, mod).
- __rrshift__(self, value, /)
- Return value>>self.
- __rshift__(self, value, /)
- Return self>>value.
- __rsub__(self, value, /)
- Return value-self.
- __rtruediv__(self, value, /)
- Return value/self.
- __rxor__(self, value, /)
- Return value^self.
- __sizeof__(self, /)
- Returns size in memory, in bytes.
- __sub__(self, value, /)
- Return self-value.
- __truediv__(self, value, /)
- Return self/value.
- __trunc__(...)
- Truncating an Integral returns itself.
- __xor__(self, value, /)
- Return self^value.
- as_integer_ratio(self, /)
- Return a pair of integers, whose ratio is equal to the original int.
The ratio is in lowest terms and has a positive denominator.
>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)
- bit_count(self, /)
- Number of ones in the binary representation of the absolute value of self.
Also known as the population count.
>>> bin(13)
'0b1101'
>>> (13).bit_count()
3
- bit_length(self, /)
- Number of bits necessary to represent self in binary.
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
- conjugate(...)
- Returns self, the complex conjugate of any int.
- is_integer(self, /)
- Returns True. Exists for duck type compatibility with float.is_integer.
- to_bytes(self, /, length=1, byteorder='big', *, signed=False)
- Return an array of bytes representing an integer.
length
Length of bytes object to use. An OverflowError is raised if the
integer is not representable with the given number of bytes. Default
is length 1.
byteorder
The byte order used to represent the integer. If byteorder is 'big',
the most significant byte is at the beginning of the byte array. If
byteorder is 'little', the most significant byte is at the end of the
byte array. To request the native byte order of the host system, use
`sys.byteorder' as the byte order value. Default is to use 'big'.
signed
Determines whether two's complement is used to represent the integer.
If signed is False and a negative integer is given, an OverflowError
is raised.
Class methods inherited from builtins.int:
- from_bytes(bytes, byteorder='big', *, signed=False) from builtins.type
- Return the integer represented by the given array of bytes.
bytes
Holds the array of bytes to convert. The argument must either
support the buffer protocol or be an iterable object producing bytes.
Bytes and bytearray are examples of built-in objects that support the
buffer protocol.
byteorder
The byte order used to represent the integer. If byteorder is 'big',
the most significant byte is at the beginning of the byte array. If
byteorder is 'little', the most significant byte is at the end of the
byte array. To request the native byte order of the host system, use
`sys.byteorder' as the byte order value. Default is to use 'big'.
signed
Indicates whether two's complement is used to represent the integer.
Data descriptors inherited from builtins.int:
- denominator
- the denominator of a rational number in lowest terms
- imag
- the imaginary part of a complex number
- numerator
- the numerator of a rational number in lowest terms
- real
- the real part of a complex number
| |