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. final def ==(arg0: Any): Boolean

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

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

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

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

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

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

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

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

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

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  14. def allowPartialyAssigned: UInt2D.this.type

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

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

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

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

    Permalink
    Definition Classes
    Data
  19. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  20. def asData: Data

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

    Permalink

    set a data as inout

    set a data as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

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

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

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

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

    Permalink
    Definition Classes
    Data
  31. 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
  32. def clone(): Bundle

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

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

    Permalink
    Definition Classes
    Assignable
  35. var compositeAssign: Assignable

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

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

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

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

    Permalink
    Definition Classes
    BundleMultiData
  40. def elementsString: String

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

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

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

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

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

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

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

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

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

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

    Permalink

    flip the direction of the data

    flip the direction of the data

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  53. def genIf(cond: Boolean): UInt2D.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  54. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  58. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  60. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  61. def getMode: Byte

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

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

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

    Permalink
    Definition Classes
    Nameable
  65. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  66. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  68. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  69. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  70. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  74. def getTypeString: String

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

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  76. val globalData: GlobalData

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  84. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  85. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  86. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  87. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  88. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  89. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  90. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  91. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  93. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  94. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  95. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  97. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  98. def isUnnamed: Boolean

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

    Permalink
    Definition Classes
    Data
  100. var name: String

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  109. var parent: Data

    Permalink
    Definition Classes
    Data
  110. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  111. 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
  112. def purify(): UInt2D.this.type

    Permalink
    Definition Classes
    Data
  113. 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
  114. var refOwner: RefOwnerType

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

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

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

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

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

    Permalink

    Resized data regarding target

    Resized data regarding target

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Permalink

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  155. val xBitCount: BitCount

    Permalink

    width of the x point

  156. val y: UInt

    Permalink
  157. 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

  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