spinal.core

UInt2D

Related Docs: object UInt2D | package core

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. OverridedEqualsHashCode
  8. MultiData
  9. Data
  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
Learn more about member selection
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. final def ==(arg0: Any): Boolean

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

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

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

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

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

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

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

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

    Allow a data to be overrided

    Allow a data to be overrided

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

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

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

    Definition Classes
    Data
  16. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  17. def asData: Data

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

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

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

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

    Set a data as output

    Set a data as output

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

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

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

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

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

    Definition Classes
    Data
  28. 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
  29. def clone(): Bundle

    Definition Classes
    BundleData → AnyRef
  30. var cloneFunc: () ⇒ AnyRef

    Definition Classes
    Bundle
  31. def component: Component

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

    Definition Classes
    Assignable
  33. var compositeAssign: Assignable

    Definition Classes
    Assignable
  34. def dirString(): String

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

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

    Return all element of the bundle

    Return all element of the bundle

    Definition Classes
    BundleMultiData
  37. def elementsString: String

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

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

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

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

    Definition Classes
    SpinalTagReady
  42. def finalize(): Unit

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

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

    Definition Classes
    SpinalTagReady
  45. def flatten: Seq[BaseType]

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

    Definition Classes
    MultiDataData
  47. def flattenLocalName: Seq[String]

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

    flip the direction of the data

    flip the direction of the data

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

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

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  51. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

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

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

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  55. def getDisplayName(): String

    Definition Classes
    Nameable
  56. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  57. def getName(): String

    Definition Classes
    NameableByComponentNameable
  58. def getName(default: String): String

    Definition Classes
    Nameable
  59. def getRealSource: Any

    Definition Classes
    Assignable
  60. def getRealSourceNoRec: Any

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

    Definition Classes
    OwnableRef
  62. def getRootParent: Data

    Definition Classes
    Data
  63. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  64. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  65. def getScalaTrace(): Throwable

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

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

    Definition Classes
    SpinalTagReady
  68. def getTypeString: String

    Definition Classes
    Bundle
  69. def getZero: UInt2D.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  70. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  71. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

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

    Definition Classes
    SpinalTagReady
  73. def hashCode(): Int

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

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

    Definition Classes
    SpinalTagReady
  76. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  77. def isAnalog: Boolean

    Definition Classes
    Data
  78. def isComb: Boolean

    Definition Classes
    Data
  79. def isDirectionLess: Boolean

    Definition Classes
    Data
  80. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  81. def isInOut: Boolean

    Definition Classes
    Data
  82. def isInput: Boolean

    Definition Classes
    Data
  83. def isInputOrInOut: Boolean

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

    Definition Classes
    Any
  85. def isNamed: Boolean

    Definition Classes
    Nameable
  86. def isOutput: Boolean

    Definition Classes
    Data
  87. def isOutputOrInOut: Boolean

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

    Definition Classes
    Nameable
  89. def isReg: Boolean

    Definition Classes
    Data
  90. def isUnnamed: Boolean

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

    Definition Classes
    Data
  92. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  93. def noBackendCombMerge: UInt2D.this.type

    Definition Classes
    Data
  94. def noCombLoopCheck: UInt2D.this.type

    Definition Classes
    Data
  95. final def notify(): Unit

    Definition Classes
    AnyRef
  96. final def notifyAll(): Unit

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

    Definition Classes
    SpinalTagReady
  98. var parent: Data

    Definition Classes
    Data
  99. var parentScope: ScopeStatement

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

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

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

    Definition Classes
    OwnableRef
  104. def removeAssignments(): UInt2D.this.type

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

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

    Definition Classes
    SpinalTagReady
  107. def resized: UInt2D.this.type

    Resized data regarding target

    Resized data regarding target

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

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    Nameable
  130. def spinalTags: Set[SpinalTag]

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

    Definition Classes
    AnyRef
  132. def toString(): String

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

    Definition Classes
    Nameable
  134. final def wait(): Unit

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

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

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

  138. val xBitCount: BitCount

    width of the x point

  139. val y: UInt

  140. val yBitCount: BitCount

    width of the y point

Deprecated Value Members

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

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    use setAsDirectionLess instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

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