1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-09-20 06:05:46 +02:00
MLEM/Docs/api/MLEM.Extensions.ColorHelper.yml

576 lines
18 KiB
YAML
Generated

### YamlMime:ManagedReference
items:
- uid: MLEM.Extensions.ColorHelper
commentId: T:MLEM.Extensions.ColorHelper
id: ColorHelper
parent: MLEM.Extensions
children:
- MLEM.Extensions.ColorHelper.FromHexRgb(System.Int32)
- MLEM.Extensions.ColorHelper.FromHexRgba(System.Int32)
- MLEM.Extensions.ColorHelper.FromHexString(System.String)
- MLEM.Extensions.ColorHelper.TryFromHexString(System.String,Microsoft.Xna.Framework.Color@)
langs:
- csharp
- vb
name: ColorHelper
nameWithType: ColorHelper
fullName: MLEM.Extensions.ColorHelper
type: Class
source:
remote:
path: MLEM/Extensions/ColorExtensions.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: ColorHelper
path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 65
assemblies:
- MLEM
namespace: MLEM.Extensions
summary: A set of utility methods for dealing with <xref href="Microsoft.Xna.Framework.Color" data-throw-if-not-resolved="false"></xref> objects.
example: []
syntax:
content: public static class ColorHelper
content.vb: Public Module ColorHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.ToString
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- uid: MLEM.Extensions.ColorHelper.FromHexRgba(System.Int32)
commentId: M:MLEM.Extensions.ColorHelper.FromHexRgba(System.Int32)
id: FromHexRgba(System.Int32)
parent: MLEM.Extensions.ColorHelper
langs:
- csharp
- vb
name: FromHexRgba(int)
nameWithType: ColorHelper.FromHexRgba(int)
fullName: MLEM.Extensions.ColorHelper.FromHexRgba(int)
type: Method
source:
remote:
path: MLEM/Extensions/ColorExtensions.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: FromHexRgba
path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 73
assemblies:
- MLEM
namespace: MLEM.Extensions
summary: >-
Parses a hexadecimal number into an rgba color.
The number should be in the format <code>0xaarrggbb</code>.
example: []
syntax:
content: public static Color FromHexRgba(int value)
parameters:
- id: value
type: System.Int32
description: The number to parse.
return:
type: Microsoft.Xna.Framework.Color
description: The resulting color.
content.vb: Public Shared Function FromHexRgba(value As Integer) As Color
overload: MLEM.Extensions.ColorHelper.FromHexRgba*
nameWithType.vb: ColorHelper.FromHexRgba(Integer)
fullName.vb: MLEM.Extensions.ColorHelper.FromHexRgba(Integer)
name.vb: FromHexRgba(Integer)
- uid: MLEM.Extensions.ColorHelper.FromHexRgb(System.Int32)
commentId: M:MLEM.Extensions.ColorHelper.FromHexRgb(System.Int32)
id: FromHexRgb(System.Int32)
parent: MLEM.Extensions.ColorHelper
langs:
- csharp
- vb
name: FromHexRgb(int)
nameWithType: ColorHelper.FromHexRgb(int)
fullName: MLEM.Extensions.ColorHelper.FromHexRgb(int)
type: Method
source:
remote:
path: MLEM/Extensions/ColorExtensions.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: FromHexRgb
path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 83
assemblies:
- MLEM
namespace: MLEM.Extensions
summary: >-
Parses a hexadecimal number into an rgb color with 100% alpha.
The number should be in the format <code>0xrrggbb</code>.
example: []
syntax:
content: public static Color FromHexRgb(int value)
parameters:
- id: value
type: System.Int32
description: The number to parse.
return:
type: Microsoft.Xna.Framework.Color
description: The resulting color.
content.vb: Public Shared Function FromHexRgb(value As Integer) As Color
overload: MLEM.Extensions.ColorHelper.FromHexRgb*
nameWithType.vb: ColorHelper.FromHexRgb(Integer)
fullName.vb: MLEM.Extensions.ColorHelper.FromHexRgb(Integer)
name.vb: FromHexRgb(Integer)
- uid: MLEM.Extensions.ColorHelper.FromHexString(System.String)
commentId: M:MLEM.Extensions.ColorHelper.FromHexString(System.String)
id: FromHexString(System.String)
parent: MLEM.Extensions.ColorHelper
langs:
- csharp
- vb
name: FromHexString(string)
nameWithType: ColorHelper.FromHexString(string)
fullName: MLEM.Extensions.ColorHelper.FromHexString(string)
type: Method
source:
remote:
path: MLEM/Extensions/ColorExtensions.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: FromHexString
path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 94
assemblies:
- MLEM
namespace: MLEM.Extensions
summary: >-
Parses a hexadecimal string into a color and throws a <xref href="System.FormatException" data-throw-if-not-resolved="false"></xref> if parsing fails.
The string can either be formatted as <code>RRGGBB</code> or <code>AARRGGBB</code> and can optionally start with a <code>#</code>.
example: []
syntax:
content: public static Color FromHexString(string value)
parameters:
- id: value
type: System.String
description: The string to parse.
return:
type: Microsoft.Xna.Framework.Color
description: The resulting color.
content.vb: Public Shared Function FromHexString(value As String) As Color
overload: MLEM.Extensions.ColorHelper.FromHexString*
exceptions:
- type: System.FormatException
commentId: T:System.FormatException
description: Thrown if parsing fails.
nameWithType.vb: ColorHelper.FromHexString(String)
fullName.vb: MLEM.Extensions.ColorHelper.FromHexString(String)
name.vb: FromHexString(String)
- uid: MLEM.Extensions.ColorHelper.TryFromHexString(System.String,Microsoft.Xna.Framework.Color@)
commentId: M:MLEM.Extensions.ColorHelper.TryFromHexString(System.String,Microsoft.Xna.Framework.Color@)
id: TryFromHexString(System.String,Microsoft.Xna.Framework.Color@)
parent: MLEM.Extensions.ColorHelper
langs:
- csharp
- vb
name: TryFromHexString(string, out Color)
nameWithType: ColorHelper.TryFromHexString(string, out Color)
fullName: MLEM.Extensions.ColorHelper.TryFromHexString(string, out Microsoft.Xna.Framework.Color)
type: Method
source:
remote:
path: MLEM/Extensions/ColorExtensions.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: TryFromHexString
path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 107
assemblies:
- MLEM
namespace: MLEM.Extensions
summary: >-
Tries to parse a hexadecimal string into a color and returns whether a color was successfully parsed.
The string can either be formatted as <code>RRGGBB</code> or <code>AARRGGBB</code> and can optionally start with a <code>#</code>.
example: []
syntax:
content: public static bool TryFromHexString(string value, out Color color)
parameters:
- id: value
type: System.String
description: The string to parse.
- id: color
type: Microsoft.Xna.Framework.Color
description: The resulting color.
return:
type: System.Boolean
description: Whether parsing was successful.
content.vb: Public Shared Function TryFromHexString(value As String, color As Color) As Boolean
overload: MLEM.Extensions.ColorHelper.TryFromHexString*
nameWithType.vb: ColorHelper.TryFromHexString(String, Color)
fullName.vb: MLEM.Extensions.ColorHelper.TryFromHexString(String, Microsoft.Xna.Framework.Color)
name.vb: TryFromHexString(String, Color)
references:
- uid: Microsoft.Xna.Framework.Color
commentId: T:Microsoft.Xna.Framework.Color
parent: Microsoft.Xna.Framework
isExternal: true
name: Color
nameWithType: Color
fullName: Microsoft.Xna.Framework.Color
- uid: MLEM.Extensions
commentId: N:MLEM.Extensions
href: MLEM.html
name: MLEM.Extensions
nameWithType: MLEM.Extensions
fullName: MLEM.Extensions
spec.csharp:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Extensions
name: Extensions
href: MLEM.Extensions.html
spec.vb:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Extensions
name: Extensions
href: MLEM.Extensions.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: Microsoft.Xna.Framework
commentId: N:Microsoft.Xna.Framework
isExternal: true
name: Microsoft.Xna.Framework
nameWithType: Microsoft.Xna.Framework
fullName: Microsoft.Xna.Framework
spec.csharp:
- uid: Microsoft
name: Microsoft
isExternal: true
- name: .
- uid: Microsoft.Xna
name: Xna
isExternal: true
- name: .
- uid: Microsoft.Xna.Framework
name: Framework
isExternal: true
spec.vb:
- uid: Microsoft
name: Microsoft
isExternal: true
- name: .
- uid: Microsoft.Xna
name: Xna
isExternal: true
- name: .
- uid: Microsoft.Xna.Framework
name: Framework
isExternal: true
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: MLEM.Extensions.ColorHelper.FromHexRgba*
commentId: Overload:MLEM.Extensions.ColorHelper.FromHexRgba
href: MLEM.Extensions.ColorHelper.html#MLEM_Extensions_ColorHelper_FromHexRgba_System_Int32_
name: FromHexRgba
nameWithType: ColorHelper.FromHexRgba
fullName: MLEM.Extensions.ColorHelper.FromHexRgba
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.int32
name: int
nameWithType: int
fullName: int
nameWithType.vb: Integer
fullName.vb: Integer
name.vb: Integer
- uid: MLEM.Extensions.ColorHelper.FromHexRgb*
commentId: Overload:MLEM.Extensions.ColorHelper.FromHexRgb
href: MLEM.Extensions.ColorHelper.html#MLEM_Extensions_ColorHelper_FromHexRgb_System_Int32_
name: FromHexRgb
nameWithType: ColorHelper.FromHexRgb
fullName: MLEM.Extensions.ColorHelper.FromHexRgb
- uid: System.FormatException
commentId: T:System.FormatException
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.formatexception
name: FormatException
nameWithType: FormatException
fullName: System.FormatException
- uid: MLEM.Extensions.ColorHelper.FromHexString*
commentId: Overload:MLEM.Extensions.ColorHelper.FromHexString
href: MLEM.Extensions.ColorHelper.html#MLEM_Extensions_ColorHelper_FromHexString_System_String_
name: FromHexString
nameWithType: ColorHelper.FromHexString
fullName: MLEM.Extensions.ColorHelper.FromHexString
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: MLEM.Extensions.ColorHelper.TryFromHexString*
commentId: Overload:MLEM.Extensions.ColorHelper.TryFromHexString
href: MLEM.Extensions.ColorHelper.html#MLEM_Extensions_ColorHelper_TryFromHexString_System_String_Microsoft_Xna_Framework_Color__
name: TryFromHexString
nameWithType: ColorHelper.TryFromHexString
fullName: MLEM.Extensions.ColorHelper.TryFromHexString
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean