Class/Object

spinal.core

UInt2D

Related Docs: object UInt2D | package core

Permalink

case class UInt2D(xBitCount: BitCount, yBitCount: BitCount) extends Bundle with Product with Serializable

Define an UInt 2D point

xBitCount

width of the x point

yBitCount

width of the y point

Example:
  1. val positionOnScreen = Reg(UInt2D(log2Up(p.screenResX) bits, log2Up(p.screenResY) bits))
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UInt2D
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Bundle
  7. MultiData
  8. Data
  9. OverridedEqualsHashCode
  10. SpinalTagReady
  11. Assignable
  12. NameableByComponent
  13. Nameable
  14. OwnableRef
  15. ContextUser
  16. ScalaLocated
  17. GlobalDataUser
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UInt2D(xBitCount: BitCount, yBitCount: BitCount)

    Permalink

    xBitCount

    width of the x point

    yBitCount

    width of the y point

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. var _spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  6. def addAttribute(attribute: Attribute): UInt2D.this.type

    Permalink
    Definition Classes
    DataSpinalTagReady
  7. def addAttribute(name: String, value: String): UInt2D.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): UInt2D.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  9. def addTag[T <: SpinalTag](spinalTag: T): UInt2D.this.type

    Permalink
    Definition Classes
    MultiDataSpinalTagReady
  10. def addTags[T <: SpinalTag](tags: Iterable[T]): UInt2D.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  11. def allowDirectionLessIo: UInt2D.this.type

    Permalink
    Definition Classes
    Data
  12. def allowOverride: UInt2D.this.type

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  13. def allowPruning(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  14. def allowSimplifyIt(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  15. def allowUnsetRegToAvoidLatch: UInt2D.this.type

    Permalink
    Definition Classes
    Data
  16. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  17. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  18. def asData: Data

    Permalink
    Definition Classes
    Data
  19. def asInOut(): UInt2D.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  20. def asInput(): UInt2D.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    MultiDataData
  21. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  22. def asOutput(): UInt2D.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  23. def assignAllByName(that: Bundle): Unit

    Permalink

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

    Definition Classes
    Bundle
  24. def assignDontCare(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  25. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  26. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    MultiDataData
  27. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiDataData
  28. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data
  29. def assignSomeByName(that: Bundle): Unit

    Permalink

    Assign all possible signal fo the bundle with an other bundle by name

    Assign all possible signal fo the bundle with an other bundle by name

    Definition Classes
    Bundle
  30. def clone(): Bundle

    Permalink
    Definition Classes
    BundleData → AnyRef
  31. def component: Component

    Permalink
    Definition Classes
    ContextUser
  32. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Permalink
    Definition Classes
    Assignable
  33. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  34. def copyDirectionOfImpl(that: Data): UInt2D.this.type

    Permalink
    Definition Classes
    MultiDataData
  35. def dirString(): String

    Permalink
    Definition Classes
    Data
  36. def dontSimplifyIt(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  37. def elements: ArrayBuffer[(String, Data)]

    Permalink

    Return all element of the bundle

    Return all element of the bundle

    Definition Classes
    BundleMultiData
  38. def elementsString: String

    Permalink
    Definition Classes
    MultiData
  39. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  40. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  41. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  42. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  43. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  44. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData
  45. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  46. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiDataData
  47. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiDataData
  48. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiDataData
  49. def flip(): UInt2D.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiDataData
  50. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  51. def genIf(cond: Boolean): UInt2D.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  52. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiDataData
  53. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  54. def getComponent(): Component

    Permalink
    Definition Classes
    DataNameableByComponent
  55. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  56. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  57. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  58. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  59. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  60. def getName(): String

    Permalink
    Definition Classes
    Nameable
  61. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  62. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  63. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  64. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  65. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  66. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  67. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  68. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  69. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  70. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  71. def getTypeString: String

    Permalink
    Definition Classes
    Bundle
  72. def getZero: UInt2D.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  73. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  74. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle
  75. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  76. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  77. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  78. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  79. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  80. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  81. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  82. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  83. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  84. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  85. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  86. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  87. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  88. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  89. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  90. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  91. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  92. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  93. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  94. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  95. def keep(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  96. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  97. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  98. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  99. def noBackendCombMerge: UInt2D.this.type

    Permalink
    Definition Classes
    Data
  100. def noCombLoopCheck: UInt2D.this.type

    Permalink
    Definition Classes
    Data
  101. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  102. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  103. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  104. var parent: Data

    Permalink
    Definition Classes
    Data
  105. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  106. def pull(): UInt2D.this.type

    Permalink

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  107. def purify(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  108. def randBoot(): UInt2D.this.type

    Permalink

    Usefull for register that doesn't need a reset value in RTL, but need a randome value for simulation (avoid x-propagation)

    Usefull for register that doesn't need a reset value in RTL, but need a randome value for simulation (avoid x-propagation)

    Definition Classes
    Data
  109. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  110. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  111. def removeAssignments(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  112. def removeTag(spinalTag: SpinalTag): UInt2D.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  113. def removeTags(tags: Iterable[SpinalTag]): UInt2D.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  114. def resized: UInt2D.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  115. def setAsAnalog(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  116. def setAsComb(): UInt2D.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  117. def setAsDirectionLess(): UInt2D.this.type

    Permalink

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    MultiDataData
  118. def setAsReg(): UInt2D.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiDataData
  119. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  120. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  121. def setCompositeName(nameable: Nameable, postfix: String): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  122. def setCompositeName(nameable: Nameable, namePriority: Byte): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  123. def setCompositeName(nameable: Nameable, weak: Boolean): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  124. def setCompositeName(nameable: Nameable): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  125. def setName(name: String, namePriority: Byte): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  126. def setName(name: String, weak: Boolean): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  127. def setName(name: String): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  128. def setPartialName(name: String, namePriority: Byte): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  129. def setPartialName(name: String, weak: Boolean): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  130. def setPartialName(owner: Nameable, name: String, namePriority: Byte): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  131. def setPartialName(owner: Nameable, name: String, weak: Boolean): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  132. def setPartialName(name: String): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  133. def setPartialName(owner: Nameable, name: String): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  134. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  135. def setScalaLocated(source: ScalaLocated): UInt2D.this.type

    Permalink
    Definition Classes
    ScalaLocated
  136. def setWeakName(name: String): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  137. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  138. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  139. def toString(): String

    Permalink
    Definition Classes
    BundleNameable → AnyRef → Any
  140. def unsetName(): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  141. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  142. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  143. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. val x: UInt

    Permalink
  145. val xBitCount: BitCount

    Permalink

    width of the x point

  146. val y: UInt

    Permalink
  147. val yBitCount: BitCount

    Permalink

    width of the y point

Deprecated Value Members

  1. def asDirectionLess(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Bundle

Inherited from MultiData

Inherited from Data

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped