Packages

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
Serializable, Serializable, Product, Equals, Bundle, ValCallbackRec, ValCallback, MultiData, Data, InComponent, OverridedEqualsHashCode, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UInt2D
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Bundle
  7. ValCallbackRec
  8. ValCallback
  9. MultiData
  10. Data
  11. InComponent
  12. OverridedEqualsHashCode
  13. SpinalTagReady
  14. Assignable
  15. NameableByComponent
  16. Nameable
  17. OwnableRef
  18. ContextUser
  19. ScalaLocated
  20. GlobalDataUser
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    xBitCount

    width of the x point

    yBitCount

    width of the y point

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  7. def addAttribute(attribute: Attribute): UInt2D.this.type
    Definition Classes
    Data → SpinalTagReady
  8. def addAttribute(name: String, value: Int): UInt2D.this.type
    Definition Classes
    SpinalTagReady
  9. def addAttribute(name: String, value: String): UInt2D.this.type
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String): UInt2D.this.type
    Definition Classes
    SpinalTagReady
  11. def addTag[T <: SpinalTag](spinalTag: T): UInt2D.this.type
    Definition Classes
    MultiData → SpinalTagReady
  12. def addTags[T <: SpinalTag](tags: Iterable[T]): UInt2D.this.type
    Definition Classes
    SpinalTagReady
  13. def allowDirectionLessIo(): UInt2D.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

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

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  15. def allowPartialyAssigned(): UInt2D.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  16. def allowPruning(): UInt2D.this.type
    Definition Classes
    Data
  17. def allowSimplifyIt(): UInt2D.this.type
    Definition Classes
    Data
  18. def allowUnsetRegToAvoidLatch(): UInt2D.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  19. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  20. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiData → Data
  21. def asData: Data
    Definition Classes
    Data
  22. def asInOut(): UInt2D.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    MultiData → Data
  23. def asInput(): UInt2D.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    MultiData → Data
  24. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  25. def asOutput(): UInt2D.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiData → Data
  26. def assignAllByName(that: Bundle): Unit

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

    Definition Classes
    Bundle
  27. def assignDontCare(): UInt2D.this.type
    Definition Classes
    Data
  28. def assignDontCareToUnasigned(): UInt2D.this.type
    Definition Classes
    Data
  29. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  30. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  31. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  32. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  33. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  34. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  35. def assignSomeByName(that: Bundle): Unit

    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
  36. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  37. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit
    Definition Classes
    Bundle
  38. def checkDir(that: Bundle): Boolean

    for interface find modport

    for interface find modport

    Definition Classes
    Bundle
  39. def clearAll(): UInt2D.this.type
    Definition Classes
    Data
  40. def clone(): Bundle
    Definition Classes
    Bundle → Data → AnyRef
  41. def component: Component
    Definition Classes
    ContextUser
  42. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  43. val compositeAssign: Assignable
    Definition Classes
    Assignable
  44. def copyDirectionOfImpl(that: Data): UInt2D.this.type
    Definition Classes
    MultiData → Data
  45. def dirString(): String
    Definition Classes
    Data
  46. def dontSimplifyIt(): UInt2D.this.type
    Definition Classes
    Data
  47. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  48. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  49. def elementsString: String
    Definition Classes
    MultiData
  50. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  52. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  53. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  54. def find(name: String): Data
    Definition Classes
    MultiData
  55. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  56. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  57. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  58. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  59. def flip(): UInt2D.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiData → Data
  60. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  61. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  62. def freeze(): UInt2D.this.type
    Definition Classes
    MultiData → Data
  63. def getAheadValue(): UInt2D.this.type
    Definition Classes
    Data
  64. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiData → Data
  65. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  67. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  68. def getDirection: IODirection
    Definition Classes
    Data
  69. def getDisplayName(): String
    Definition Classes
    Nameable
  70. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  71. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  72. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  73. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  74. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  75. def getPartialName(): String
    Definition Classes
    Nameable
  76. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  77. def getRealSource: Any
    Definition Classes
    Assignable
  78. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  79. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  80. def getRootParent: Data
    Definition Classes
    Data
  81. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  82. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  83. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  84. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  85. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  86. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  87. def getTypeString: String
    Definition Classes
    Bundle
  88. def getZero: UInt2D.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiData → Data
  89. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  90. var hardtype: HardType[_]
    Definition Classes
    Bundle
  91. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  92. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  93. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  94. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  95. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  96. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  97. def isAnalog: Boolean
    Definition Classes
    Data
  98. def isComb: Boolean
    Definition Classes
    Data
  99. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  100. def isDirectionLess: Boolean
    Definition Classes
    Data
  101. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  102. def isInOut: Boolean
    Definition Classes
    Data
  103. def isInput: Boolean
    Definition Classes
    Data
  104. def isInputOrInOut: Boolean
    Definition Classes
    Data
  105. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  106. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  107. def isOutput: Boolean
    Definition Classes
    Data
  108. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  109. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  110. def isReg: Boolean
    Definition Classes
    Data
  111. def isRegOnAssign: Boolean
    Definition Classes
    Data
  112. def isUnnamed: Boolean
    Definition Classes
    Nameable
  113. val name: String
    Definition Classes
    Nameable
  114. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  115. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  116. def noBackendCombMerge(): UInt2D.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  117. def noCombLoopCheck(): UInt2D.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  118. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  119. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  120. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  121. def overrideLocalName(name: String): UInt2D.this.type
    Definition Classes
    Nameable
  122. val parent: Data
    Definition Classes
    Data
  123. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  124. def pull(propagateName: Boolean): UInt2D.this.type
    Definition Classes
    Data
  125. def pull(): UInt2D.this.type

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

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

    Definition Classes
    Data
  126. def purify(): UInt2D.this.type
    Definition Classes
    Data
  127. def randBoot(u: Unit): UInt2D.this.type

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

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

    Definition Classes
    Data
  128. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  129. def reflectNames(): Unit
    Definition Classes
    Nameable
  130. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): UInt2D.this.type
    Definition Classes
    Data
  131. def removeDataAssignments(): UInt2D.this.type
    Definition Classes
    Data
  132. def removeInitAssignments(): UInt2D.this.type
    Definition Classes
    Data
  133. def removeTag(spinalTag: SpinalTag): UInt2D.this.type
    Definition Classes
    SpinalTagReady
  134. def removeTags(tags: Iterable[SpinalTag]): UInt2D.this.type
    Definition Classes
    SpinalTagReady
  135. def resized: UInt2D.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  136. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  137. def rootIFList(): List[Interface]
    Definition Classes
    Data
  138. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  139. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  140. def setAll(): UInt2D.this.type
    Definition Classes
    Data
  141. def setAsAnalog(): UInt2D.this.type
    Definition Classes
    Data
  142. def setAsComb(): UInt2D.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiData → Data
  143. def setAsDirectionLess(): UInt2D.this.type

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

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

    Definition Classes
    MultiData → Data
  144. def setAsReg(): UInt2D.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiData → Data
  145. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): UInt2D.this.type
    Definition Classes
    Nameable
  146. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): UInt2D.this.type
    Definition Classes
    Nameable
  147. def setCompositeName(nameable: Nameable, postfix: String): UInt2D.this.type
    Definition Classes
    Nameable
  148. def setCompositeName(nameable: Nameable, namePriority: Byte): UInt2D.this.type
    Definition Classes
    Nameable
  149. def setCompositeName(nameable: Nameable, weak: Boolean): UInt2D.this.type
    Definition Classes
    Nameable
  150. def setCompositeName(nameable: Nameable): UInt2D.this.type
    Definition Classes
    Nameable
  151. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): UInt2D.this.type
    Definition Classes
    Nameable
  152. def setName(name: String, namePriority: Byte): UInt2D.this.type
    Definition Classes
    Nameable
  153. def setName(name: String, weak: Boolean): UInt2D.this.type
    Definition Classes
    Nameable
  154. def setName(name: String): UInt2D.this.type
    Definition Classes
    Nameable
  155. def setNameAsWeak(): UInt2D.this.type
    Definition Classes
    Nameable
  156. def setOutputAsReg(): UInt2D.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  157. def setPartialName(name: String, namePriority: Byte, owner: Any): UInt2D.this.type
    Definition Classes
    Nameable
  158. def setPartialName(name: String, namePriority: Byte): UInt2D.this.type
    Definition Classes
    Nameable
  159. def setPartialName(name: String, weak: Boolean): UInt2D.this.type
    Definition Classes
    Nameable
  160. def setPartialName(owner: Nameable, name: String, namePriority: Byte): UInt2D.this.type
    Definition Classes
    Nameable
  161. def setPartialName(owner: Nameable, name: String, weak: Boolean): UInt2D.this.type
    Definition Classes
    Nameable
  162. def setPartialName(name: String): UInt2D.this.type
    Definition Classes
    Nameable
  163. def setPartialName(owner: Nameable, name: String): UInt2D.this.type
    Definition Classes
    Nameable
  164. def setPartialName(owner: Nameable): UInt2D.this.type
    Definition Classes
    Nameable
  165. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  166. def setScalaLocated(source: ScalaLocated): UInt2D.this.type
    Definition Classes
    ScalaLocated
  167. def setWeakName(name: String): UInt2D.this.type
    Definition Classes
    Nameable
  168. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  169. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  170. def toIo(): UInt2D.this.type
    Definition Classes
    Data
  171. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  172. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  173. def unfreeze(): UInt2D.this.type
    Definition Classes
    MultiData → Data
  174. def unsetName(): UInt2D.this.type
    Definition Classes
    Nameable
  175. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  176. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  177. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  178. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  179. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  180. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  181. def wrapNext(): UInt2D.this.type
    Definition Classes
    Data
  182. val x: UInt
  183. val xBitCount: BitCount
  184. val y: UInt
  185. val yBitCount: BitCount
  186. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): UInt2D.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  3. def genIf(cond: Boolean): UInt2D.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Bundle

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from MultiData

Inherited from Data

Inherited from InComponent

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