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. 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)

    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. def #*(count: Int): Bits

    Permalink
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  13. def allowDirectionLessIo(): UInt2D.this.type

    Permalink

    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

    Permalink

    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

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    Data
  18. def allowUnsetRegToAvoidLatch(): UInt2D.this.type

    Permalink

    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

    Permalink
    Definition Classes
    Data
  20. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  21. def asData: Data

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

    Permalink

    set a data as inout

    set a data as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  26. 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
  27. def assignDontCare(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  28. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiDataData
  29. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit

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

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

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

    Permalink
    Definition Classes
    Data
  33. 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
  34. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData
  35. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Bundle
  36. def clone(): Bundle

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

    Permalink
    Definition Classes
    ContextUser
  38. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable
  39. var compositeAssign: Assignable

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

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

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

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

    Permalink
    Definition Classes
    BundleMultiData
  44. var elementsCache: ArrayBuffer[(String, Data)]

    Permalink
    Definition Classes
    Bundle
  45. def elementsString: String

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  50. def find(name: String): Data

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

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

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

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

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

    Permalink

    flip the direction of the data

    flip the direction of the data

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

    Permalink
    Definition Classes
    Nameable
  57. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  58. def freeze(): UInt2D.this.type

    Permalink
    Definition Classes
    MultiDataData
  59. def genIf(cond: Boolean): UInt2D.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  60. def getAheadValue(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  61. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  63. def getComponent(): Component

    Permalink
    Definition Classes
    DataInComponentNameableByComponent
  64. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  65. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  66. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  67. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  68. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  69. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data
  70. def getName(default: String): String

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

    Permalink
    Definition Classes
    NameableByComponentNameable
  72. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  73. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  74. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  75. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  77. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  78. def getRtlPath(separator: String = "/"): String

    Permalink
    Definition Classes
    Data
  79. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  80. def getScalaLocationShort: String

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  83. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  84. def getTypeString: String

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

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  86. val globalData: GlobalData

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  94. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  95. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  96. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  97. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  98. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  99. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  100. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  101. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  103. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  104. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  105. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  107. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  108. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  109. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  110. var name: String

    Permalink
    Definition Classes
    Nameable
  111. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  113. def noBackendCombMerge(): UInt2D.this.type

    Permalink

    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
  114. def noCombLoopCheck(): UInt2D.this.type

    Permalink

    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
  115. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  116. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  117. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  118. def overrideLocalName(name: String): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  119. var parent: Data

    Permalink
    Definition Classes
    Data
  120. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  121. def pull(propagateName: Boolean): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  122. 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
  123. def purify(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  124. def randBoot(u: Unit): UInt2D.this.type

    Permalink

    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
  125. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  127. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  128. def removeDataAssignments(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  129. def removeInitAssignments(): UInt2D.this.type

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

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

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

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  133. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  134. def setAsAnalog(): UInt2D.this.type

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  136. 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
  137. def setAsReg(): UInt2D.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  144. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): UInt2D.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  148. def setNameAsWeak(): UInt2D.this.type

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  156. def setPartialName(owner: Nameable): UInt2D.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  160. def spinalTags: LinkedHashSet[SpinalTag]

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

    Permalink
    Definition Classes
    AnyRef
  162. def toIo(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  163. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data
  164. def toString(): String

    Permalink
    Definition Classes
    BundleNameable → AnyRef → Any
  165. def unfreeze(): UInt2D.this.type

    Permalink
    Definition Classes
    MultiDataData
  166. def unsetName(): UInt2D.this.type

    Permalink
    Definition Classes
    Nameable
  167. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  168. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  169. def valCallbackRec(ref: Any, name: String): Unit

    Permalink
    Definition Classes
    BundleValCallbackRec
  170. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  172. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  173. def wrapNext(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  174. val x: UInt

    Permalink
  175. val xBitCount: BitCount

    Permalink

    width of the x point

  176. val y: UInt

    Permalink
  177. val yBitCount: BitCount

    Permalink

    width of the y point

  178. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]

    Permalink
    Definition Classes
    MultiData

Deprecated Value Members

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

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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